shepherd-core 2024.9.1__py3-none-any.whl → 2024.11.1__py3-none-any.whl

shepherd_core/data_models/content/virtual_source_fixture.yaml

@@ -102,6 +102,7 @@
     enable_feedback_to_hrv: true  # src can control a cv-harvester for ivcurve
     V_intermediate_enable_threshold_mV: 2000
     V_intermediate_disable_threshold_mV: 1800  # nRF draw ~0.5 mA below that point
+    # TODO: put switch-output into special nRF Version
 
 - datatype: VirtualSourceConfig
   parameters:

shepherd_core/version.py

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

shepherd_core/vsource/target_model.py

@@ -79,10 +79,10 @@ class DiodeTarget(TargetABC):
 
     def step(self, voltage_uV: int, *, pwr_good: bool) -> float:
         if pwr_good or not self.ctrl:
-            V_CC = voltage_uV * 1e-3
+            V_CC = voltage_uV * 1e-6
             V_D = V_CC / 2
             I_R = I_D = 0
-            # there is no direct formular, but this recursion converges fast
+            # there is no direct formular, but this iteration converges fast
             for _ in range(10):
                 # low voltages tend to produce log(x<0)=err
                 with suppress(ValueError):
@@ -90,8 +90,9 @@ class DiodeTarget(TargetABC):
                 # both currents are positive and should be identical
                 I_R = max(0.0, (V_CC - V_D) / self.R_Ohm)
                 I_D = max(0.0, self.I_S * math.expm1(V_D / self.c1))
-                if abs(I_R / I_D - 1) < 1e-6:
-                    break
+                with suppress(ZeroDivisionError):
+                    if abs(I_R / I_D - 1) < 1e-6:
+                        break
                 # take mean of both currents and determine a new V_D
                 V_D = V_CC - self.R_Ohm * (I_R + I_D) / 2
             return 1e9 * (I_R + I_D) / 2  # = nA

shepherd_core/vsource/virtual_converter_model.py

@@ -101,7 +101,7 @@ class VirtualConverterModel:
 
         # pulled from update_states_and_output() due to easier static init
         self.sample_count: int = 0xFFFFFFF0
-        self.is_outputting: bool = True
+        self.is_outputting: bool = False
         self.vsource_skip_gpio_logging: bool = False
 
     def calc_inp_power(self, input_voltage_uV: float, input_current_nA: float) -> int:
@@ -180,6 +180,7 @@ class VirtualConverterModel:
 
     # TODO: add range-checks for add, sub Ops
     def update_cap_storage(self) -> int:
+        # TODO: this calculation is wrong for everything beside boost-cnv
         if self.enable_storage:
             V_mid_prot_uV = max(1.0, self.V_mid_uV)
             P_sum_fW = self.P_inp_fW - self.P_out_fW
@@ -194,22 +195,24 @@ class VirtualConverterModel:
     def update_states_and_output(self) -> int:
         self.sample_count += 1
         check_thresholds = self.sample_count >= self._cfg.interval_check_thresholds_n
+        V_mid_uV_now = self.V_mid_uV
+        # copy avoids not enabling pwr_good (due to large dV_enable_output_uV)
 
         if check_thresholds:
             self.sample_count = 0
             if self.is_outputting:
-                if self.V_mid_uV < self.V_disable_output_threshold_uV:
+                if V_mid_uV_now < self.V_disable_output_threshold_uV:
                     self.is_outputting = False
-            elif self.V_mid_uV >= self.V_enable_output_threshold_uV:
+            elif V_mid_uV_now >= self.V_enable_output_threshold_uV:
                 self.is_outputting = True
                 self.V_mid_uV -= self.dV_enable_output_uV
 
         if check_thresholds or self._cfg.immediate_pwr_good_signal:
             # generate power-good-signal
             if self.power_good:
-                if self.V_mid_uV <= self._cfg.V_pwr_good_disable_threshold_uV:
+                if V_mid_uV_now <= self._cfg.V_pwr_good_disable_threshold_uV:
                     self.power_good = False
-            elif self.V_mid_uV >= self._cfg.V_pwr_good_enable_threshold_uV:
+            elif V_mid_uV_now >= self._cfg.V_pwr_good_enable_threshold_uV:
                 self.power_good = self.is_outputting
             # set batok pin to state ... TODO?
 

shepherd_core/vsource/virtual_harvester_model.py

@@ -170,8 +170,9 @@ class VirtualHarvesterModel:
 
         _voltage_uV, _current_nA = self.ivcurve_2_cv(_voltage_uV, _current_nA)
         if self.interval_step < self._cfg.duration_n:
+            self.voltage_set_uV = self.voc_now
+        elif self.interval_step == self._cfg.duration_n:
             self.voltage_set_uV = int(self.voc_now * self._cfg.setpoint_n8 / 256)
-            _current_nA = 0
 
         return _voltage_uV, _current_nA
 

shepherd_core/writer.py

@@ -94,7 +94,7 @@ class Writer(Reader):
 
     comp_default: int = 1
     mode_default: str = "harvester"
-    datatype_default: str = EnergyDType.ivsample
+    datatype_default: EnergyDType = EnergyDType.ivsample
 
     _chunk_shape: tuple = (Reader.samples_per_buffer,)
 
@@ -137,79 +137,72 @@ class Writer(Reader):
                 self.file_path.name,
             )
 
+        # open file
+        if self._modify:
+            self.h5file = h5py.File(self.file_path, "r+")  # = rw
+        else:
+            if not self.file_path.parent.exists():
+                self.file_path.parent.mkdir(parents=True)
+            self.h5file = h5py.File(self.file_path, "w")
+            # ⤷ write, truncate if exist
+            self._create_skeleton()
+
+        # Handle Mode
         if isinstance(mode, str) and mode not in self.mode_dtype_dict:
             msg = f"Can't handle mode '{mode}' (choose one of {self.mode_dtype_dict})"
             raise ValueError(msg)
 
-        _dtypes = self.mode_dtype_dict[mode or self.mode_default]
+        if mode is not None:
+            self.h5file.attrs["mode"] = mode
+        if "mode" not in self.h5file.attrs:
+            self.h5file.attrs["mode"] = self.mode_default
+
+        _dtypes = self.mode_dtype_dict[self.get_mode()]
+
+        # Handle Datatype
         if isinstance(datatype, str):
             datatype = EnergyDType[datatype]
         if isinstance(datatype, EnergyDType) and datatype not in _dtypes:
             msg = f"Can't handle value '{datatype}' of datatype (choose one of {_dtypes})"
             raise ValueError(msg)
 
-        if self._modify:
-            if mode:
-                self._mode = mode
-            if not hasattr(self, "_mode"):
-                self._mode = self.mode_default
-            if datatype:
-                self._datatype = datatype
-            if not hasattr(self, "_datatype"):
-                self._datatype = self.datatype_default
-            if window_samples:
-                self._window_samples = window_samples
-            if not hasattr(self, "_window_samples"):
-                self._window_samples = 0
-        else:
-            self._mode = mode if isinstance(mode, str) else self.mode_default
-            self._datatype = (
-                datatype if isinstance(datatype, EnergyDType) else self.datatype_default
+        if isinstance(datatype, EnergyDType):
+            self.h5file["data"].attrs["datatype"] = datatype.name
+        if "datatype" not in self.h5file["data"].attrs:
+            self.h5file["data"].attrs["datatype"] = self.datatype_default.name
+        if self.get_datatype() not in _dtypes:
+            msg = (
+                f"Can't handle value '{self.get_datatype()}' of datatype (choose one of {_dtypes})"
             )
-            self._window_samples = window_samples if isinstance(window_samples, int) else 0
+            raise ValueError(msg)
 
+        # Handle Window_samples
+        if window_samples is not None:
+            self.h5file["data"].attrs["window_samples"] = window_samples
+        if "window_samples" not in self.h5file["data"].attrs:
+            self.h5file["data"].attrs["window_samples"] = 0
+
+        if datatype == EnergyDType.ivcurve and self.get_window_samples() < 1:
+            raise ValueError("Window Size argument needed for ivcurve-Datatype")
+
+        # Handle Cal
         if isinstance(cal_data, (CalEmu, CalHrv)):
-            self._cal = CalSeries.from_cal(cal_data)
-        elif isinstance(cal_data, CalSeries):
-            self._cal = cal_data
-        else:
-            self._cal = CalSeries()
+            cal_data = CalSeries.from_cal(cal_data)
 
-        # open file
-        if self._modify:
-            self.h5file = h5py.File(self.file_path, "r+")  # = rw
+        if isinstance(cal_data, CalSeries):
+            for ds, param in product(["current", "voltage", "time"], ["gain", "offset"]):
+                self.h5file["data"][ds].attrs[param] = cal_data[ds][param]
         else:
-            if not self.file_path.parent.exists():
-                self.file_path.parent.mkdir(parents=True)
-            self.h5file = h5py.File(self.file_path, "w")
-            # ⤷ write, truncate if exist
-            self._create_skeleton()
+            # check if there are unset cal-values and set them to default
+            cal_data = CalSeries()
+            for ds, param in product(["current", "voltage", "time"], ["gain", "offset"]):
+                if param not in self.h5file["data"][ds].attrs:
+                    self.h5file["data"][ds].attrs[param] = cal_data[ds][param]
 
         # show key parameters for h5-performance
         settings = list(self.h5file.id.get_access_plist().get_cache())
         self._logger.debug("H5Py Cache_setting=%s (_mdc, _nslots, _nbytes, _w0)", settings)
 
-        # Store the mode in order to allow user to differentiate harvesting vs emulation data
-        if isinstance(self._mode, str) and self._mode in self.mode_dtype_dict:
-            self.h5file.attrs["mode"] = self._mode
-
-        if (
-            isinstance(self._datatype, EnergyDType)
-            and self._datatype in self.mode_dtype_dict[self.get_mode()]
-        ):
-            self.h5file["data"].attrs["datatype"] = self._datatype.name
-        elif not self._modify:
-            self._logger.error("datatype invalid? '%s' not written", self._datatype)
-
-        if isinstance(self._window_samples, int):
-            self.h5file["data"].attrs["window_samples"] = self._window_samples
-        if datatype == EnergyDType.ivcurve and (self._window_samples in {None, 0}):
-            raise ValueError("Window Size argument needed for ivcurve-Datatype")
-
-        # include cal-data
-        for ds, param in product(["current", "voltage", "time"], ["gain", "offset"]):
-            self.h5file["data"][ds].attrs[param] = self._cal[ds][param]
-
         super().__init__(file_path=None, verbose=verbose)
 
     def __enter__(self) -> Self:

{shepherd_core-2024.9.1.dist-info → shepherd_core-2024.11.1.dist-info}/METADATA

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

@@ -3,8 +3,8 @@ 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=Sg7s5UfV01CejI3_nolG7qrSDUBenmt1WPo2BPJee8o,27058
-shepherd_core/version.py,sha256=27CgGjJQqgAy26osZGWijS3x6BU9n5GVv3D0T_smBy4,75
-shepherd_core/writer.py,sha256=t53fXkYUWHhYnOFnHCoMWwUADkgYydy9Dg66PiqPa68,14946
+shepherd_core/version.py,sha256=_cAEEjp9MalkLrnbibrPNp6zEr3U5KIC-gmZvPG5QqA,76
+shepherd_core/writer.py,sha256=GMR-7vkOgpTNPoknBWsRsC7-b7iGMtT60-KtSKunNe8,14636
 shepherd_core/data_models/__init__.py,sha256=IVjKbT2Ilz5bev325EvAuuhd9LfQgQ1u7qKo6dhVA2k,1866
 shepherd_core/data_models/readme.md,sha256=1bdfEypY_0NMhXLxOPRnLAsFca0HuHdq7_01yEWxvUs,2470
 shepherd_core/data_models/virtual_source_doc.txt,sha256=KizMcfGKj7BnHIbaJHT7KeTF01SV__UXv01qV_DGHSs,6057
@@ -24,7 +24,7 @@ shepherd_core/data_models/content/firmware_datatype.py,sha256=XPU9LOoT3h5qFOlE8W
 shepherd_core/data_models/content/virtual_harvester.py,sha256=MXmSJ_nRp1mSzxfTNk60o9h5Yrp2lFMbLphUVSnNeNc,9999
 shepherd_core/data_models/content/virtual_harvester_fixture.yaml,sha256=LZe5ue1xYhXZwB3a32sva-L4uKhkQA5AtG9JzW4B2hQ,4564
 shepherd_core/data_models/content/virtual_source.py,sha256=PPAphxEXvgMM7OVZ2dBkYAvJQkmj5Kb2BYFogVUs7B8,15354
-shepherd_core/data_models/content/virtual_source_fixture.yaml,sha256=wdHwuTf8-EhuSLnCQA5Ay68aiyKtXBEtJqfSc4v0sKg,11136
+shepherd_core/data_models/content/virtual_source_fixture.yaml,sha256=1o-31mGgn7eyCNidKoOUp9vZh3K4Al0kJgmz54Q2DAE,11191
 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
@@ -67,14 +67,14 @@ shepherd_core/testbed_client/client_web.py,sha256=iMh5T91152uugbFsqr2vvxLser0KIo
 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=GVB-FwuO2mvM15mGX9EQC1lbUmHMLmUEFGYkGmIngPM,771
-shepherd_core/vsource/target_model.py,sha256=xix2VqH9PeVbMG0Pq7jpwrnD1dEbCASb3x0Llgmqge8,5055
-shepherd_core/vsource/virtual_converter_model.py,sha256=Mhm0iss8CD8Xcg6fsmtSp5w3Jc1zzV6RxOVOQC-tXto,11405
-shepherd_core/vsource/virtual_harvester_model.py,sha256=_Qq5F_0AeqkMHKcLvWQWne6ENsmygFgoSi-IXebRKAA,9689
+shepherd_core/vsource/target_model.py,sha256=LaB5ppi2-IIpIepDqDvOliR-BupzccJl44yRxjlF-ms,5113
+shepherd_core/vsource/virtual_converter_model.py,sha256=3TyxphUMunoGhMda7AWCHZQU8pjRSvxB-9R8lfZFnok,11592
+shepherd_core/vsource/virtual_harvester_model.py,sha256=GyA0uGl3r42t5c4roYtEaj22b0-b5DAHUr2e9DuNn-c,9765
 shepherd_core/vsource/virtual_harvester_simulation.py,sha256=EiBrvmc6D2N7Z0DqFBWPdRJK6hR8Q3iQaj7EYP9pLA0,2405
 shepherd_core/vsource/virtual_source_model.py,sha256=-JSYUfsnYlNo5RfPBhx2G33fo5AjSeFSf2O6unroyFw,2945
 shepherd_core/vsource/virtual_source_simulation.py,sha256=k1v2zpNdJTqiO9uY8TXaq-IUKK6m5l-LEWebYva0skk,5088
-shepherd_core-2024.9.1.dist-info/METADATA,sha256=LlCH9yhqfIQRRZnSscGSeEad4xPaqCWw53zRi2kgF9s,7817
-shepherd_core-2024.9.1.dist-info/WHEEL,sha256=cVxcB9AmuTcXqmwrtPhNK88dr7IR_b6qagTj0UvIEbY,91
-shepherd_core-2024.9.1.dist-info/top_level.txt,sha256=wy-t7HRBrKARZxa-Y8_j8d49oVHnulh-95K9ikxVhew,14
-shepherd_core-2024.9.1.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-shepherd_core-2024.9.1.dist-info/RECORD,,
+shepherd_core-2024.11.1.dist-info/METADATA,sha256=TPLadz0PyPjY4RxradpDtestEq_6U2ILu9tVNIIG7q0,7818
+shepherd_core-2024.11.1.dist-info/WHEEL,sha256=P9jw-gEje8ByB7_hXoICnHtVCrEwMQh-630tKvQWehc,91
+shepherd_core-2024.11.1.dist-info/top_level.txt,sha256=wy-t7HRBrKARZxa-Y8_j8d49oVHnulh-95K9ikxVhew,14
+shepherd_core-2024.11.1.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+shepherd_core-2024.11.1.dist-info/RECORD,,

{shepherd_core-2024.9.1.dist-info → shepherd_core-2024.11.1.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (74.1.2)
+Generator: setuptools (75.3.0)
 Root-Is-Purelib: true
 Tag: py3-none-any