shepherd-core 2024.8.1__py3-none-any.whl → 2024.8.2__py3-none-any.whl

shepherd_core/data_models/content/virtual_source_fixture.yaml

@@ -15,7 +15,7 @@
     interval_startup_delay_drain_ms: 0
 
     harvester:
-      name: mppt_opt # harvester only active if input is "ivcurves"
+      name: mppt_opt # harvester only active if input is "ivcurve"
 
     V_input_max_mV: 10000
     I_input_max_mA: 4200

shepherd_core/version.py

@@ -1,3 +1,3 @@
 """Separated string avoids circular imports."""
 
-version: str = "2024.8.1"
+version: str = "2024.8.2"

shepherd_core/vsource/__init__.py

@@ -1,13 +1,23 @@
 """Simulation model of the virtual source."""
 
+from .target_model import ConstantCurrentTarget
+from .target_model import ConstantPowerTarget
+from .target_model import ResistiveTarget
 from .virtual_converter_model import PruCalibration
 from .virtual_converter_model import VirtualConverterModel
 from .virtual_harvester_model import VirtualHarvesterModel
+from .virtual_harvester_simulation import simulate_harvester
 from .virtual_source_model import VirtualSourceModel
+from .virtual_source_simulation import simulate_source
 
 __all__ = [
     "PruCalibration",
     "VirtualConverterModel",
     "VirtualHarvesterModel",
     "VirtualSourceModel",
+    "simulate_harvester",
+    "simulate_source",
+    "ResistiveTarget",
+    "ConstantCurrentTarget",
+    "ConstantPowerTarget",
 ]

shepherd_core/vsource/target_model.py

@@ -0,0 +1,62 @@
+"""Virtual targets with different characteristics.
+
+TODO: add more targets
+  - diode
+  - constant power
+  - constant current
+  - msp430 (const I)
+  - nRF (constant power due to regulator)
+  - riotee
+"""
+
+from abc import ABC
+from abc import abstractmethod
+
+
+class TargetABC(ABC):
+    """Abstract base class for all targets."""
+
+    @abstractmethod
+    def step(self, voltage_uV: int, *, pwr_good: bool) -> float:
+        """Calculate one time step and return drawn current in nA."""
+
+
+class ResistiveTarget(TargetABC):
+    """Predictable target for matching the real world."""
+
+    def __init__(self, resistance_Ohm: float, *, controlled: bool = False) -> None:
+        if resistance_Ohm <= 1e-3:
+            raise ValueError("Resistance must be greater than 1 mOhm.")
+        self.r_kOhm = 1e-3 * resistance_Ohm
+        self.ctrl = controlled
+
+    def step(self, voltage_uV: int, *, pwr_good: bool) -> float:
+        if pwr_good or not self.ctrl:
+            return voltage_uV / self.r_kOhm  # = nA
+        return 0
+
+
+class ConstantCurrentTarget(TargetABC):
+    """Recreate simple MCU without integrated regulator."""
+
+    def __init__(self, i_active_A: float, i_sleep_A: float = 0) -> None:
+        if i_active_A <= 0 or i_sleep_A <= 0:
+            raise ValueError("Current must be greater than 0.")
+        self.i_active_nA = 1e9 * i_active_A
+        self.i_sleep_nA = 1e9 * i_sleep_A
+
+    def step(self, voltage_uV: int, *, pwr_good: bool) -> float:  # noqa: ARG002
+        return self.i_active_nA if pwr_good else self.i_sleep_nA
+
+
+class ConstantPowerTarget(TargetABC):
+    """Recreate MCU with integrated regulator."""
+
+    def __init__(self, p_active_W: float, p_sleep_W: float = 0) -> None:
+        if p_active_W <= 0 or p_sleep_W <= 0:
+            raise ValueError("Power must be greater than 0.")
+        self.p_active_fW = 1e15 * p_active_W
+        self.p_sleep_fW = 1e15 * p_sleep_W
+
+    def step(self, voltage_uV: int, *, pwr_good: bool) -> float:
+        return (self.p_active_fW if pwr_good else self.p_sleep_fW) / voltage_uV  # = nA

shepherd_core/vsource/virtual_harvester_simulation.py

@@ -0,0 +1,71 @@
+"""Simulate behavior of virtual harvester algorithms.
+
+The simulation recreates an observer-cape and the virtual harvester
+- input = hdf5-file with an ivcurve
+- output = optional as hdf5-file
+
+The output file can be analyzed and plotted with shepherds tool suite.
+"""
+
+from contextlib import ExitStack
+from pathlib import Path
+from typing import Optional
+
+from tqdm import tqdm
+
+from .. import CalibrationHarvester
+from .. import Reader
+from .. import Writer
+from ..data_models.content.virtual_harvester import HarvesterPRUConfig
+from ..data_models.content.virtual_harvester import VirtualHarvesterConfig
+from .virtual_harvester_model import VirtualHarvesterModel
+
+
+def simulate_harvester(
+    config: VirtualHarvesterConfig, path_input: Path, path_output: Optional[Path] = None
+) -> float:
+    """Simulate behavior of virtual harvester algorithms.
+
+    Fn return the harvested energy.
+    """
+    stack = ExitStack()
+    file_inp = Reader(path_input, verbose=False)
+    stack.enter_context(file_inp)
+    cal_inp = file_inp.get_calibration_data()
+
+    if path_output:
+        cal_hrv = CalibrationHarvester()
+        file_out = Writer(
+            path_output, cal_data=cal_hrv, mode="harvester", verbose=False, force_overwrite=True
+        )
+        stack.enter_context(file_out)
+        cal_out = file_out.get_calibration_data()
+        file_out.store_hostname("hrv_sim_" + config.name)
+
+    hrv_pru = HarvesterPRUConfig.from_vhrv(
+        config,
+        for_emu=True,
+        dtype_in=file_inp.get_datatype(),
+        window_size=file_inp.get_window_samples(),
+    )
+    hrv = VirtualHarvesterModel(hrv_pru)
+    e_out_Ws = 0.0
+
+    for _t, v_inp, i_inp in tqdm(
+        file_inp.read_buffers(is_raw=True), total=file_inp.buffers_n, desc="Buffers", leave=False
+    ):
+        v_uV = cal_inp.voltage.raw_to_si(v_inp) * 1e6
+        i_nA = cal_inp.current.raw_to_si(i_inp) * 1e9
+        length = min(v_uV.size, i_nA.size)
+        for _n in range(length):
+            v_uV[_n], i_nA[_n] = hrv.ivcurve_sample(
+                _voltage_uV=int(v_uV[_n]), _current_nA=int(i_nA[_n])
+            )
+        e_out_Ws += (v_uV * i_nA).sum() * 1e-15 * file_inp.sample_interval_s
+        if path_output:
+            v_out = cal_out.voltage.si_to_raw(v_uV / 1e6)
+            i_out = cal_out.current.si_to_raw(i_nA / 1e9)
+            file_out.append_iv_data_raw(_t, v_out, i_out)
+
+    stack.close()
+    return e_out_Ws

shepherd_core/vsource/virtual_source_simulation.py

@@ -0,0 +1,78 @@
+"""Simulate behavior of virtual source algorithms.
+
+The simulation recreates an observer-cape, the virtual Source and a virtual target
+- input = hdf5-file with a harvest-recording
+- output = optional as hdf5-file
+
+The output file can be analyzed and plotted with shepherds tool suite.
+"""
+
+from contextlib import ExitStack
+from pathlib import Path
+from typing import Optional
+
+from tqdm import tqdm
+
+from .. import CalibrationEmulator
+from .. import Reader
+from .. import Writer
+from ..data_models import VirtualSourceConfig
+from . import VirtualSourceModel
+from .target_model import TargetABC
+
+
+def simulate_source(
+    config: VirtualSourceConfig,
+    target: TargetABC,
+    path_input: Path,
+    path_output: Optional[Path] = None,
+) -> float:
+    """Simulate behavior of virtual source algorithms.
+
+    FN returns the consumed energy of the target.
+    """
+    stack = ExitStack()
+    file_inp = Reader(path_input, verbose=False)
+    stack.enter_context(file_inp)
+    cal_emu = CalibrationEmulator()
+    cal_inp = file_inp.get_calibration_data()
+
+    if path_output:
+        file_out = Writer(
+            path_output, cal_data=cal_emu, mode="emulator", verbose=False, force_overwrite=True
+        )
+        stack.enter_context(file_out)
+        file_out.store_hostname("emu_sim_" + config.name)
+        file_out.store_config(config.model_dump())
+        cal_out = file_out.get_calibration_data()
+
+    src = VirtualSourceModel(
+        config, cal_emu, log_intermediate=False, window_size=file_inp.get_window_samples()
+    )
+    i_out_nA = 0
+    e_out_Ws = 0.0
+
+    for _t, v_inp, i_inp in tqdm(
+        file_inp.read_buffers(is_raw=True), total=file_inp.buffers_n, desc="Buffers", leave=False
+    ):
+        v_uV = 1e6 * cal_inp.voltage.raw_to_si(v_inp)
+        i_nA = 1e9 * cal_inp.current.raw_to_si(i_inp)
+
+        for _n in range(len(_t)):
+            v_uV[_n] = src.iterate_sampling(
+                V_inp_uV=int(v_uV[_n]),
+                I_inp_nA=int(i_nA[_n]),
+                I_out_nA=i_out_nA,
+            )
+            i_out_nA = target.step(int(v_uV[_n]), pwr_good=src.cnv.get_power_good())
+            i_nA[_n] = i_out_nA
+            # TODO: src.cnv.get_I_mod_out_nA() has more internal drains
+
+        e_out_Ws += (v_uV * i_nA).sum() * 1e-15 * file_inp.sample_interval_s
+        if path_output:
+            v_out = cal_out.voltage.si_to_raw(1e-6 * v_uV)
+            i_out = cal_out.current.si_to_raw(1e-9 * i_nA)
+            file_out.append_iv_data_raw(_t, v_out, i_out)
+
+    stack.close()
+    return e_out_Ws

{shepherd_core-2024.8.1.dist-info → shepherd_core-2024.8.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: shepherd_core
-Version: 2024.8.1
+Version: 2024.8.2
 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-2024.8.1.dist-info → shepherd_core-2024.8.2.dist-info}/RECORD

@@ -3,7 +3,7 @@ shepherd_core/calibration_hw_def.py,sha256=_nMzgNzSnYyqcLnVCGd4tfA2e0avUXbccjmNp
 shepherd_core/commons.py,sha256=vymKXWcy_1bz7ChzzEATUkJ4p3czCzjIdsSehVjJOY8,218
 shepherd_core/logger.py,sha256=4Q4hTI-nccOZ1_A68fo4UEctfu3pJx3IeHfa9VuDDEo,1804
 shepherd_core/reader.py,sha256=xpzwt1JjubNat0PNwdzmBJltLPOmvCyQGwcC-bq83ZI,27052
-shepherd_core/version.py,sha256=xmbickJLTzW9cd7jhYX7fdLN72fW-vKC8QWUEFq3lR4,75
+shepherd_core/version.py,sha256=2UChDgJ4n71vSZH0_L2ArDetMFRZd-5aZO5ppY2Yhrg,75
 shepherd_core/writer.py,sha256=t53fXkYUWHhYnOFnHCoMWwUADkgYydy9Dg66PiqPa68,14946
 shepherd_core/data_models/__init__.py,sha256=IVjKbT2Ilz5bev325EvAuuhd9LfQgQ1u7qKo6dhVA2k,1866
 shepherd_core/data_models/readme.md,sha256=1bdfEypY_0NMhXLxOPRnLAsFca0HuHdq7_01yEWxvUs,2470
@@ -24,7 +24,7 @@ shepherd_core/data_models/content/firmware_datatype.py,sha256=XPU9LOoT3h5qFOlE8W
 shepherd_core/data_models/content/virtual_harvester.py,sha256=52HNac5k_GBCAhT2jBgu8oIqnvwMN3WMVmsAJrrxVRo,9678
 shepherd_core/data_models/content/virtual_harvester_fixture.yaml,sha256=1u-V9RvFhbU74wEUv-BMQugh7OdzBE1SvhVe1v0DN-8,4251
 shepherd_core/data_models/content/virtual_source.py,sha256=2ebNI1CvZgcfY5nz9P9p-Vr26E9l9bli9YeEd6_7yBY,14364
-shepherd_core/data_models/content/virtual_source_fixture.yaml,sha256=qmtZp4Tcf5K8l65AjqOZhH-kDAaXs7YUIZNjJwaQhm8,10526
+shepherd_core/data_models/content/virtual_source_fixture.yaml,sha256=8Y1HwGRUPKTA6xwI74MFXFYUT018aI7WRlkPIhODwcQ,10525
 shepherd_core/data_models/experiment/__init__.py,sha256=9TE9_aSnCNRhagsIWLTE8XkyjyMGB7kEGdswl-296v0,645
 shepherd_core/data_models/experiment/experiment.py,sha256=wnn6T3czuh4rz6OSYtMltCTbRpPX55TLVAtQcKO7Uhg,4044
 shepherd_core/data_models/experiment/observer_features.py,sha256=qxnb7anuQz9ZW5IUlPdUXYPIl5U7O9uXkJqZtMnAb0Y,5156
@@ -66,12 +66,15 @@ shepherd_core/testbed_client/client_abc_fix.py,sha256=BsSkpvJHURRejlS-YPF1f6QRPC
 shepherd_core/testbed_client/client_web.py,sha256=iMh5T91152uugbFsqr2vvxLser0KIo5g426dp_6QWUE,5774
 shepherd_core/testbed_client/fixtures.py,sha256=4Uk583R4r6I5IB78HxOn-9UNH3sbFha7OPEdcSXvMCU,9939
 shepherd_core/testbed_client/user_model.py,sha256=5M3vWkAGBwdGDUYAanAjrZwpzMBlh3XLOVvNYWiLmms,2107
-shepherd_core/vsource/__init__.py,sha256=dS33KYLq5GQ9_D8HfdP8iWSocWTghCi2ZZG2AJWNfaM,391
+shepherd_core/vsource/__init__.py,sha256=GVB-FwuO2mvM15mGX9EQC1lbUmHMLmUEFGYkGmIngPM,771
+shepherd_core/vsource/target_model.py,sha256=J_8-MHs_gIMcE3ZYTgoFsrO6VShR6SFJ5CA3lwuPC2U,2049
 shepherd_core/vsource/virtual_converter_model.py,sha256=sQkJSj-7CVabHvXqk6C3cbLmztSSsdrSU3WgYr4h30E,11067
 shepherd_core/vsource/virtual_harvester_model.py,sha256=ROR8vtKeM2WTnogV68TKBOu0zRVwOwQj_q67hW_qtpQ,8297
+shepherd_core/vsource/virtual_harvester_simulation.py,sha256=EiBrvmc6D2N7Z0DqFBWPdRJK6hR8Q3iQaj7EYP9pLA0,2405
 shepherd_core/vsource/virtual_source_model.py,sha256=fjN8myTY3I_LpikF_aGAcxes3RGu1GP23P7XKC_UIyA,2737
-shepherd_core-2024.8.1.dist-info/METADATA,sha256=-DJfS_CoIctcSz8u4V-85AUpTYrcLVDZ0Pc8UQScNJI,7771
-shepherd_core-2024.8.1.dist-info/WHEEL,sha256=R0nc6qTxuoLk7ShA2_Y-UWkN8ZdfDBG2B6Eqpz2WXbs,91
-shepherd_core-2024.8.1.dist-info/top_level.txt,sha256=wy-t7HRBrKARZxa-Y8_j8d49oVHnulh-95K9ikxVhew,14
-shepherd_core-2024.8.1.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-shepherd_core-2024.8.1.dist-info/RECORD,,
+shepherd_core/vsource/virtual_source_simulation.py,sha256=swopkXe60LozBkp_-e1WCla-eVCG2klTFB5bLAUj51I,2528
+shepherd_core-2024.8.2.dist-info/METADATA,sha256=oDQiB1H6NM3zW-SuQp0uZ1Ap366o5syvqE-5RLWrIws,7771
+shepherd_core-2024.8.2.dist-info/WHEEL,sha256=R0nc6qTxuoLk7ShA2_Y-UWkN8ZdfDBG2B6Eqpz2WXbs,91
+shepherd_core-2024.8.2.dist-info/top_level.txt,sha256=wy-t7HRBrKARZxa-Y8_j8d49oVHnulh-95K9ikxVhew,14
+shepherd_core-2024.8.2.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+shepherd_core-2024.8.2.dist-info/RECORD,,