shepherd-core 2024.7.4__tar.gz → 2024.8.2__tar.gz

{shepherd_core-2024.7.4 → shepherd_core-2024.8.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: shepherd_core
-Version: 2024.7.4
+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.2/examples/eenv_generator.py

@@ -0,0 +1,43 @@
+"""Create a set of static artificial energy environments."""
+
+from itertools import product
+from pathlib import Path
+
+import numpy as np
+from tqdm import trange
+
+from shepherd_core import Reader as ShpReader
+from shepherd_core import Writer as ShpWriter
+from shepherd_core import logger
+
+# Config
+voltages_V = [4.0, 2.0]
+currents_A = [2e-3, 1e-3]
+duration_s = 10
+repetitions = 1
+
+path_here = Path(__file__).parent.absolute()
+
+for _v, _c in product(voltages_V, currents_A):
+    v_str = f"{round(_v * 1000)}mV"
+    c_str = f"{round(_c * 1000)}mA"
+    t_str = f"{round(duration_s * repetitions)}s"
+    name = f"eenv_static_{v_str}_{c_str}_{t_str}"
+    file_path = path_here / f"{name}.h5"
+
+    if file_path.exists():
+        logger.info("File exists, will skip: %s", file_path.name)
+    else:
+        with ShpWriter(file_path) as file:
+            file.store_hostname("artificial")
+            # values in SI units
+            timestamp_vector = np.arange(0.0, duration_s, file.sample_interval_ns / 1e9)
+            voltage_vector = np.linspace(_v, _v, int(file.samplerate_sps * duration_s))
+            current_vector = np.linspace(_c, _c, int(file.samplerate_sps * duration_s))
+
+            for idx in trange(repetitions, desc="generate", leave=False):
+                timestamps = idx * duration_s + timestamp_vector
+                file.append_iv_data_si(timestamps, voltage_vector, current_vector)
+
+    with ShpReader(file_path) as file:
+        file.save_metadata()

shepherd_core-2024.7.4/examples/vharvester_simulation.py → shepherd_core-2024.8.2/examples/simulate_vharvester.py

@@ -4,14 +4,21 @@
 - harvesting is done by various algorithms and preconfigured virtual harvesters
 - results are printed on console (harvested energy)
 
+Output:
+E_out = 0.000 mWs -> cv20
+E_out = 17.165 mWs -> cv10
+E_out = 17.427 mWs -> mppt_voc
+E_out = 17.242 mWs -> mppt_bq_solar
+E_out = 13.998 mWs -> mppt_bq_thermoelectric
+E_out = 15.202 mWs -> mppt_po
+E_out = 17.811 mWs -> mppt_opt
 """
 
 from pathlib import Path
 
 from shepherd_core import Reader
 from shepherd_core.data_models import VirtualHarvesterConfig
-from shepherd_core.data_models.content.virtual_harvester import HarvesterPRUConfig
-from shepherd_core.vsource import VirtualHarvesterModel
+from shepherd_core.vsource import simulate_harvester
 from shepherd_data import ivonne
 
 # config simulation
@@ -32,6 +39,8 @@ hrv_list = [
     "mppt_opt",
 ]
 
+save_files: bool = False
+
 # convert IVonne to IVCurve
 if not file_ivcurve.exists():
     with ivonne.Reader(file_ivonne) as db:
@@ -45,29 +54,21 @@ with Reader(file_ivcurve, verbose=False) as file:
         I_in_max = max(I_in_max, _i.max())
     print(
         f"Input-file: \n"
-        f"\tE_in = {file.energy() * 1e3:.3f} mWs\n"
+        f"\tE_in = {file.energy() * 1e3:.3f} mWs (not representative)\n"
         f"\tI_in_max = {I_in_max * 1e3:.3f} mA\n"
         f"\twindow_size = {window_size} n\n",
     )
 
 # Simulation
 for hrv_name in hrv_list:
-    E_out_Ws = 0.0
-    with Reader(file_ivcurve, verbose=False) as file:
-        hrv_config = VirtualHarvesterConfig(name=hrv_name)
-        hrv_pru = HarvesterPRUConfig.from_vhrv(
-            hrv_config,
-            for_emu=True,
-            dtype_in=file.get_datatype(),
-            window_size=file.get_window_samples(),
-        )
-        hrv = VirtualHarvesterModel(hrv_pru)
-        for _t, _v, _i in file.read_buffers():
-            length = max(_v.size, _i.size)
-            for _n in range(length):
-                _v[_n], _i[_n] = hrv.ivcurve_sample(
-                    _voltage_uV=_v[_n] * 10**6, _current_nA=_i[_n] * 10**9
-                )
-            E_out_Ws += (_v * _i).sum() * 1e-15 * file.sample_interval_s
-
-        print(f"E_out = {E_out_Ws * 1e3:.3f} mWs -> {hrv_name}")
+    file_output = (
+        file_ivcurve.with_name(file_ivcurve.stem + "_" + hrv_name + file_ivcurve.suffix)
+        if save_files
+        else None
+    )
+    E_out_Ws = simulate_harvester(
+        config=VirtualHarvesterConfig(name=hrv_name),
+        path_input=file_ivcurve,
+        path_output=file_output,
+    )
+    print(f"E_out = {E_out_Ws * 1e3:.3f} mWs -> {hrv_name}")

shepherd_core-2024.8.2/examples/simulate_vsource.py

@@ -0,0 +1,55 @@
+"""Demonstrate behavior of Virtual Source Algorithms.
+
+The emulation recreates an observer-cape, the virtual Source and a virtual target
+- input = hdf5-file with a harvest-recording
+- output = hdf5-file
+- config is currently hardcoded, but it could be an emulation-task
+- target is currently a simple resistor
+
+The output file can be analyzed and plotted with shepherds tool suite.
+
+Output:
+E_out = 0.007 mWs -> direct
+E_out = 0.033 mWs -> diode+capacitor
+E_out = 0.033 mWs -> diode+resistor+capacitor
+E_out = 14.964 mWs -> BQ25504
+E_out = 15.042 mWs -> BQ25504s
+E_out = 13.909 mWs -> BQ25570
+E_out = 14.073 mWs -> BQ25570s
+"""
+
+from pathlib import Path
+
+from shepherd_core.data_models import VirtualSourceConfig
+from shepherd_core.vsource import ConstantCurrentTarget
+from shepherd_core.vsource import simulate_source
+
+# config simulation
+file_input = Path(__file__).parent / "jogging_ivcurve.h5"
+
+src_list = [
+    "direct",
+    "diode+capacitor",
+    "diode+resistor+capacitor",
+    "BQ25504",
+    "BQ25504s",
+    "BQ25570",
+    "BQ25570s",
+]
+tgt = ConstantCurrentTarget(i_active_A=1e-3, i_sleep_A=200e-9)
+save_files = False
+
+for src_name in src_list:
+    file_output = (
+        file_input.with_name(file_input.stem + "_emu_" + src_name + file_input.suffix)
+        if save_files
+        else None
+    )
+
+    e_out_Ws = simulate_source(
+        config=VirtualSourceConfig(name=src_name),
+        target=tgt,
+        path_input=file_input,
+        path_output=file_output,
+    )
+    print(f"E_out = {e_out_Ws * 1e3:.3f} mWs -> {src_name}")

{shepherd_core-2024.7.4 → shepherd_core-2024.8.2}/shepherd_core/data_models/base/calibration.py

@@ -51,7 +51,7 @@ class CalibrationPair(ShpModel):
 
     gain: PositiveFloat
     offset: float = 0
-    # TODO: add unit
+    unit: Optional[str] = None  # TODO: add units when used
 
     def raw_to_si(self, values_raw: Calc_t, *, allow_negative: bool = True) -> Calc_t:
         """Convert between physical units and raw unsigned integers."""
@@ -78,14 +78,11 @@ class CalibrationPair(ShpModel):
         return values_raw
 
     @classmethod
-    def from_fn(cls, fn: Callable) -> Self:
+    def from_fn(cls, fn: Callable, unit: Optional[str] = None) -> Self:
         """Probe linear function to determine scaling values."""
         offset = fn(0, limited=False)
         gain_inv = fn(1.0, limited=False) - offset
-        return cls(
-            gain=1.0 / float(gain_inv),
-            offset=-float(offset) / gain_inv,
-        )
+        return cls(gain=1.0 / float(gain_inv), offset=-float(offset) / gain_inv, unit=unit)
 
 
 cal_hrv_legacy = {  # legacy translator
@@ -99,10 +96,10 @@ cal_hrv_legacy = {  # legacy translator
 class CalibrationHarvester(ShpModel):
     """Container for all calibration-pairs for that device."""
 
-    dac_V_Hrv: CalibrationPair = CalibrationPair.from_fn(dac_voltage_to_raw)
-    dac_V_Sim: CalibrationPair = CalibrationPair.from_fn(dac_voltage_to_raw)
-    adc_V_Sense: CalibrationPair = CalibrationPair.from_fn(adc_voltage_to_raw)
-    adc_C_Hrv: CalibrationPair = CalibrationPair.from_fn(adc_current_to_raw)
+    dac_V_Hrv: CalibrationPair = CalibrationPair.from_fn(dac_voltage_to_raw, unit="V")
+    dac_V_Sim: CalibrationPair = CalibrationPair.from_fn(dac_voltage_to_raw, unit="V")
+    adc_V_Sense: CalibrationPair = CalibrationPair.from_fn(adc_voltage_to_raw, unit="V")
+    adc_C_Hrv: CalibrationPair = CalibrationPair.from_fn(adc_current_to_raw, unit="A")
 
     def export_for_sysfs(self) -> dict:
         """Convert and write the essential data.
@@ -143,10 +140,10 @@ class CalibrationEmulator(ShpModel):
     Differentiates between both target-ports A/B.
     """
 
-    dac_V_A: CalibrationPair = CalibrationPair.from_fn(dac_voltage_to_raw)
-    dac_V_B: CalibrationPair = CalibrationPair.from_fn(dac_voltage_to_raw)
-    adc_C_A: CalibrationPair = CalibrationPair.from_fn(adc_current_to_raw)
-    adc_C_B: CalibrationPair = CalibrationPair.from_fn(adc_current_to_raw)
+    dac_V_A: CalibrationPair = CalibrationPair.from_fn(dac_voltage_to_raw, unit="V")
+    dac_V_B: CalibrationPair = CalibrationPair.from_fn(dac_voltage_to_raw, unit="V")
+    adc_C_A: CalibrationPair = CalibrationPair.from_fn(adc_current_to_raw, unit="A")
+    adc_C_B: CalibrationPair = CalibrationPair.from_fn(adc_current_to_raw, unit="A")
 
     def export_for_sysfs(self) -> dict:
         """Convert and write the essential data.
@@ -233,10 +230,11 @@ class CalibrationCape(ShpModel):
 
         """
         dv = cls().model_dump(include={"harvester", "emulator"})
-        lw = list(dict_generator(dv))
-        values = struct.unpack(">" + len(lw) * "d", data)
+        lw1 = list(dict_generator(dv))
+        lw2 = [elem for elem in lw1 if isinstance(elem[-1], float)]
+        values = struct.unpack(">" + len(lw2) * "d", data)
         # ⤷ X => double float, big endian
-        for _i, walk in enumerate(lw):
+        for _i, walk in enumerate(lw2):
             # hardcoded fixed depth ... bad but easy
             dv[walk[0]][walk[1]][walk[2]] = float(values[_i])
         dv["cape"] = cape
@@ -252,18 +250,18 @@ class CalibrationCape(ShpModel):
 
         """
         lw = list(dict_generator(self.model_dump(include={"harvester", "emulator"})))
-        values = [walk[-1] for walk in lw]
-        return struct.pack(">" + len(lw) * "d", *values)
+        values = [walk[-1] for walk in lw if isinstance(walk[-1], float)]
+        return struct.pack(">" + len(values) * "d", *values)
 
 
 class CalibrationSeries(ShpModel):
     """Cal-Data for a typical recording of a testbed experiment."""
 
-    voltage: CalibrationPair = CalibrationPair(gain=3 * 1e-9)
+    voltage: CalibrationPair = CalibrationPair(gain=3 * 1e-9, unit="V")
     # ⤷ default allows 0 - 12 V in 3 nV-Steps
-    current: CalibrationPair = CalibrationPair(gain=250 * 1e-12)
+    current: CalibrationPair = CalibrationPair(gain=250 * 1e-12, unit="A")
     # ⤷ default allows 0 - 1 A in 250 pA - Steps
-    time: CalibrationPair = CalibrationPair(gain=1e-9)
+    time: CalibrationPair = CalibrationPair(gain=1e-9, unit="s")
     # ⤷ default = nanoseconds
 
     @classmethod

{shepherd_core-2024.7.4 → shepherd_core-2024.8.2}/shepherd_core/data_models/content/virtual_harvester.py

@@ -149,20 +149,27 @@ class VirtualHarvesterConfig(ContentModel, title="Config for the Harvester"):
 
     def calc_window_size(
         self,
-        dtype_in: Optional[EnergyDType] = EnergyDType.ivsample,
+        dtype_in: Optional[EnergyDType] = None,
         *,
         for_emu: bool,
     ) -> int:
-        if for_emu:
-            if dtype_in == EnergyDType.ivcurve:
-                return self.samples_n * (1 + self.wait_cycles)
-            if dtype_in == EnergyDType.ivsample:
-                return 0
-            # isc_voc: 2 * (1 + wait_cycles), noqa
-            raise NotImplementedError
+        if not for_emu:
+            # TODO: should be named 'for_ivcurve_recording'
+            # TODO: add extra variable to distinguish step_count
+            #       and window_size (currently mixed together)
+            # only used by ivcurve algo (in ADC-Mode)
+            return self.samples_n
 
-        # only used by ivcurve algo (in ADC-Mode)
-        return self.samples_n
+        if dtype_in is None:
+            dtype_in = self.get_datatype()
+
+        if dtype_in == EnergyDType.ivcurve:
+            return self.samples_n * (1 + self.wait_cycles)
+        if dtype_in == EnergyDType.ivsample:
+            return 0
+        if dtype_in == EnergyDType.isc_voc:
+            return 2 * (1 + self.wait_cycles)
+        raise NotImplementedError
 
 
 u32 = Annotated[int, Field(ge=0, lt=2**32)]
@@ -234,7 +241,7 @@ class HarvesterPRUConfig(ShpModel):
             dtype_in = EnergyDType[dtype_in]
         if for_emu and dtype_in not in {EnergyDType.ivsample, EnergyDType.ivcurve}:
             raise NotImplementedError
-        # TODO: use dtype properly in shepherd
+
         interval_ms, duration_ms = data.calc_timings_ms(for_emu=for_emu)
         return cls(
             algorithm=data.calc_algorithm_num(for_emu=for_emu),

{shepherd_core-2024.7.4 → shepherd_core-2024.8.2}/shepherd_core/data_models/content/virtual_harvester_fixture.yaml

@@ -19,13 +19,13 @@
     id: 1010
     name: ivcurve
     description: Postpone harvesting by sampling ivcurves (voltage stepped as sawtooth-wave)
-    comment: ~200 Hz
+    comment: ~110 Hz, Between 50 & 60 Hz line-frequency to avoid standing waves
     inherit_from: neutral
     algorithm: ivcurve
-    samples_n: 250
+    samples_n: 909
     voltage_min_mV: 0
     voltage_max_mV: 5000
-    wait_cycles: 1  # results in 200 Hz (= 100kHz /(2*250))
+    wait_cycles: 0
     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
@@ -38,20 +38,17 @@
 
 - datatype: VirtualHarvesterConfig
   parameters:
-    id: 1012
-    name: iv1000
-    comment: Name relates to curves per second
+    id: 1013
+    name: iv110 # synonym
     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
+    id: 1012
+    name: iv1000
+    comment: Name relates to curves per second
     inherit_from: ivcurve
-    samples_n: 909
+    samples_n: 100
     wait_cycles: 0
 
 - datatype: VirtualHarvesterConfig
@@ -61,7 +58,7 @@
     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)
+    wait_cycles: 4  # results in 10 kHz (isc, wait, voc, wait)
 
 - datatype: VirtualHarvesterConfig
   parameters:

{shepherd_core-2024.7.4 → shepherd_core-2024.8.2}/shepherd_core/data_models/content/virtual_source.py

@@ -76,6 +76,8 @@ class VirtualSourceConfig(ContentModel, title="Config for the virtual Source"):
     # final (always last) stage to compensate undetectable current spikes
     # when enabling power for target
     C_output_uF: Annotated[float, Field(ge=0, le=4.29e6)] = 1.0
+    # TODO: C_output is handled internally as delta-V, but should be a I_transient
+    #       that makes it visible in simulation as additional i_out_drain
 
     # Extra
     V_output_log_gpio_threshold_mV: Annotated[float, Field(ge=0, le=4.29e6)] = 1_400
@@ -93,7 +95,7 @@ class VirtualSourceConfig(ContentModel, title="Config for the virtual Source"):
     # influence of cap-voltage is not implemented
     LUT_input_V_min_log2_uV: Annotated[int, Field(ge=0, le=20)] = 0
     # ⤷ 2^7 = 128 uV -> LUT[0][:] is for inputs < 128 uV
-    LUT_input_I_min_log2_nA: Annotated[int, Field(ge=0, le=20)] = 0
+    LUT_input_I_min_log2_nA: Annotated[int, Field(ge=1, le=20)] = 1
     # ⤷ 2^8 = 256 nA -> LUT[:][0] is for inputs < 256 nA
 
     # Buck Converter
@@ -103,7 +105,7 @@ class VirtualSourceConfig(ContentModel, title="Config for the virtual Source"):
 
     LUT_output_efficiency: LUT1D = 12 * [1.00]
     # ⤷ array[12] depending on output_current
-    LUT_output_I_min_log2_nA: Annotated[int, Field(ge=0, le=20)] = 0
+    LUT_output_I_min_log2_nA: Annotated[int, Field(ge=1, le=20)] = 1
     # ⤷ 2^8 = 256 nA -> LUT[0] is for inputs < 256 nA, see notes on LUT_input for explanation
 
     @model_validator(mode="before")
@@ -318,8 +320,8 @@ class ConverterPRUConfig(ShpModel):
             V_buck_drop_uV=round(data.V_buck_drop_mV * 1e3),
             # LUTs
             LUT_input_V_min_log2_uV=data.LUT_input_V_min_log2_uV,
-            LUT_input_I_min_log2_nA=data.LUT_input_I_min_log2_nA,
-            LUT_output_I_min_log2_nA=data.LUT_output_I_min_log2_nA,
+            LUT_input_I_min_log2_nA=data.LUT_input_I_min_log2_nA - 1,  # sub-1 due to later log2-op
+            LUT_output_I_min_log2_nA=data.LUT_output_I_min_log2_nA - 1,  # sub-1 due to later log2
             LUT_inp_efficiency_n8=[
                 [min(255, round(256 * ival)) for ival in il] for il in data.LUT_input_efficiency
             ],

{shepherd_core-2024.7.4 → shepherd_core-2024.8.2}/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
@@ -56,16 +56,18 @@
       [ 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
+    ]
+    # 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
+    LUT_input_I_min_log2_nA: 1 # 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
+    LUT_output_I_min_log2_nA: 1  # 2^8 = 256 nA -> array[0] is for inputs < 256 nA, see notes on LUT_input for explanation
 
     owner: Ingmar
     group: NES Lab
@@ -114,7 +116,7 @@
   parameters:
     id: 1020
     name: BQ25504
-    description: TI BQ25504 with integrated boost-converter
+    description: TI BQ25504 with integrated boost-converter. Values are taken from the DK-Board.
     inherit_from: neutral # to complete undefined vars
     enable_boost: true # if false -> v_intermediate = v_input, output-switch-hysteresis is still usable
 
@@ -124,16 +126,16 @@
     V_input_max_mV: 3000
     I_input_max_mA: 100
 
-    C_intermediate_uF: 22.0  # primary storage-Cap
+    C_intermediate_uF: 100.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
+    V_intermediate_enable_threshold_mV: 1000 # -> target gets connected (hysteresis-combo with next value)
+    V_intermediate_disable_threshold_mV: 0 # -> 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
+    V_pwr_good_disable_threshold_mV: 2340
     immediate_pwr_good_signal: false  # 1: activate instant schmitt-trigger, 0: stay in interval for checking thresholds
 
     # Boost Converter

{shepherd_core-2024.7.4 → shepherd_core-2024.8.2}/shepherd_core/reader.py

@@ -84,6 +84,7 @@ class Reader:
 
         # init stats
         self.runtime_s: float = 0
+        self.buffers_n: int = 0
         self.file_size: int = 0
         self.data_rate: float = 0
 
@@ -170,12 +171,16 @@ class Reader:
     def _refresh_file_stats(self) -> None:
         """Update internal states, helpful after resampling or other changes in data-group."""
         self.h5file.flush()
-        if (self.ds_time.shape[0] > 1) and (self.ds_time[1] != self.ds_time[0]):
-            # this assumes isochronal sampling
-            self.sample_interval_s = self._cal.time.raw_to_si(self.ds_time[1] - self.ds_time[0])
+        sample_count = self.ds_time.shape[0]
+        duration_raw = self.ds_time[sample_count - 1] - self.ds_time[0] if sample_count > 0 else 0
+        if (sample_count > 0) and (duration_raw > 0):
+            # this assumes iso-chronous sampling
+            duration_s = self._cal.time.raw_to_si(duration_raw)
+            self.sample_interval_s = duration_s / sample_count
             self.sample_interval_ns = int(10**9 * self.sample_interval_s)
-            self.samplerate_sps = max(int(10**9 // self.sample_interval_ns), 1)
+            self.samplerate_sps = max(int((sample_count - 1) / duration_s), 1)
         self.runtime_s = round(self.ds_voltage.shape[0] / self.samplerate_sps, 1)
+        self.buffers_n = int(self.ds_voltage.shape[0] // self.samples_per_buffer)
         if isinstance(self.file_path, Path):
             self.file_size = self.file_path.stat().st_size
         else:

{shepherd_core-2024.7.4 → shepherd_core-2024.8.2}/shepherd_core/version.py

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

{shepherd_core-2024.7.4 → shepherd_core-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-2024.8.2/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-2024.7.4 → shepherd_core-2024.8.2}/shepherd_core/vsource/virtual_converter_model.py

@@ -25,12 +25,28 @@ from ..data_models.content.virtual_source import ConverterPRUConfig
 class PruCalibration:
     """part of calibration.h."""
 
+    # negative residue compensation - compensate for noise around 0
+    # -> current uint-design cuts away negative part and leads to biased mean()
+    NOISE_ESTIMATE_nA: int = 2000
+    RESIDUE_SIZE_FACTOR: int = 30
+    RESIDUE_MAX_nA: int = NOISE_ESTIMATE_nA * RESIDUE_SIZE_FACTOR
+    negative_residue_nA = 0
+
     def __init__(self, cal_emu: Optional[CalibrationEmulator] = None) -> None:
         self.cal = cal_emu if cal_emu else CalibrationEmulator()
 
     def conv_adc_raw_to_nA(self, current_raw: int) -> float:
-        return self.cal.adc_C_A.raw_to_si(current_raw) * (10**9)
-        # TODO: add feature "negative residue compensation" to here
+        I_nA = self.cal.adc_C_A.raw_to_si(current_raw) * (10**9)
+        if self.cal.adc_C_A.offset < 0:
+            if I_nA > self.negative_residue_nA:
+                I_nA -= self.negative_residue_nA
+                self.negative_residue_nA = 0
+            else:
+                self.negative_residue_nA = self.negative_residue_nA - I_nA
+                if self.negative_residue_nA > self.RESIDUE_MAX_nA:
+                    self.negative_residue_nA = self.RESIDUE_MAX_nA
+                I_nA = 0
+        return I_nA
 
     @staticmethod
     def conv_adc_raw_to_uV(voltage_raw: int) -> float:
@@ -88,10 +104,11 @@ class VirtualConverterModel:
         self.vsource_skip_gpio_logging: bool = False
 
     def calc_inp_power(self, input_voltage_uV: float, input_current_nA: float) -> int:
-        # Next 2 lines are Python-specific
+        # Next 2 lines are Python-specific (model unsigned int)
         input_voltage_uV = max(0.0, input_voltage_uV)
         input_current_nA = max(0.0, input_current_nA)
 
+        # Input diode
         if input_voltage_uV > self._cfg.V_input_drop_uV:
             input_voltage_uV -= self._cfg.V_input_drop_uV
         else:
@@ -108,8 +125,6 @@ class VirtualConverterModel:
         if self.enable_boost:
             if input_voltage_uV < self._cfg.V_input_boost_threshold_uV:
                 input_voltage_uV = 0.0
-            if input_voltage_uV > self.V_mid_uV:
-                input_voltage_uV = self.V_mid_uV
         elif not self.enable_storage:
             # direct connection
             self.V_mid_uV = input_voltage_uV
@@ -134,7 +149,7 @@ class VirtualConverterModel:
         return round(self.P_inp_fW)  # Python-specific, added for easier testing
 
     def calc_out_power(self, current_adc_raw: int) -> int:
-        # Next 2 lines are Python-specific
+        # Next 2 lines are Python-specific (model unsigned int)
         current_adc_raw = max(0, current_adc_raw)
         current_adc_raw = min((2**18) - 1, current_adc_raw)