shepherd-core 2024.11.1__tar.gz → 2024.11.3__tar.gz

{shepherd_core-2024.11.1 → shepherd_core-2024.11.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: shepherd_core
-Version: 2024.11.1
+Version: 2024.11.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-2024.11.1 → shepherd_core-2024.11.3}/examples/experiment_generic_var1.py

@@ -41,7 +41,7 @@ xp = Experiment(
     duration=30,
     target_configs=[
         TargetConfig(
-            target_IDs=range(7, 13),
+            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(

{shepherd_core-2024.11.1 → shepherd_core-2024.11.3}/examples/experiment_generic_var2.py

@@ -38,7 +38,7 @@ xp = Experiment(
     duration=30,
     target_configs=[
         TargetConfig(
-            target_IDs=range(7, 13),
+            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(

{shepherd_core-2024.11.1 → shepherd_core-2024.11.3}/shepherd_core/data_models/__init__.py

@@ -34,29 +34,27 @@ from .experiment.observer_features import SystemLogging
 from .experiment.target_config import TargetConfig
 
 __all__ = [
-    # Core
-    "CapeData",
     "CalibrationCape",
     "CalibrationEmulator",
     "CalibrationHarvester",
-    "CalibrationSeries",
     "CalibrationPair",
+    "CalibrationSeries",
+    "CapeData",
     "ContentModel",
-    "ShpModel",
-    "Wrapper",
-    # User Content
+    "EnergyDType",
+    "EnergyEnvironment",
     "Experiment",
-    "TargetConfig",
     "Firmware",
     "FirmwareDType",
-    "SystemLogging",
-    "PowerTracing",
-    "GpioTracing",
     "GpioActuation",
     "GpioEvent",
     "GpioLevel",
-    "EnergyEnvironment",
-    "EnergyDType",
-    "VirtualSourceConfig",
+    "GpioTracing",
+    "PowerTracing",
+    "ShpModel",
+    "SystemLogging",
+    "TargetConfig",
     "VirtualHarvesterConfig",
+    "VirtualSourceConfig",
+    "Wrapper",
 ]

{shepherd_core-2024.11.1 → shepherd_core-2024.11.3}/shepherd_core/data_models/content/__init__.py

@@ -11,11 +11,10 @@ from .virtual_harvester import VirtualHarvesterConfig
 from .virtual_source import VirtualSourceConfig
 
 __all__ = [
+    "EnergyDType",
     "EnergyEnvironment",
-    "VirtualSourceConfig",
-    "VirtualHarvesterConfig",
     "Firmware",
-    # Enums
-    "EnergyDType",
     "FirmwareDType",
+    "VirtualHarvesterConfig",
+    "VirtualSourceConfig",
 ]

{shepherd_core-2024.11.1 → shepherd_core-2024.11.3}/shepherd_core/data_models/content/virtual_harvester.py

@@ -239,6 +239,7 @@ class HarvesterPRUConfig(ShpModel):
         data: VirtualHarvesterConfig,
         dtype_in: Optional[EnergyDType] = EnergyDType.ivsample,
         window_size: Optional[u32] = None,
+        voltage_step_V: Optional[float] = None,
         *,
         for_emu: bool = False,
     ) -> Self:
@@ -247,17 +248,36 @@ class HarvesterPRUConfig(ShpModel):
         if for_emu and dtype_in not in {EnergyDType.ivsample, EnergyDType.ivcurve}:
             raise NotImplementedError
 
+        if for_emu and dtype_in == EnergyDType.ivcurve and voltage_step_V is None:
+            raise ValueError(
+                "For correct emulation specify voltage_step used by harvester "
+                "e.g. via file_src.get_voltage_step()"
+            )
+
+        if for_emu and dtype_in == EnergyDType.ivcurve and window_size is None:
+            raise ValueError(
+                "For correct emulation specify window_size used by harvester "
+                "e.g. via file_src.get_window_size()"
+            )
+
         interval_ms, duration_ms = data.calc_timings_ms(for_emu=for_emu)
+        window_size = (
+            window_size
+            if window_size is not None
+            else data.calc_window_size(dtype_in, for_emu=for_emu)
+        )
+        voltage_step_mV = (
+            1e3 * voltage_step_V if voltage_step_V is not None else data.voltage_step_mV
+        )
+
         return cls(
             algorithm=data.calc_algorithm_num(for_emu=for_emu),
             hrv_mode=data.calc_hrv_mode(for_emu=for_emu),
-            window_size=window_size
-            if window_size is not None
-            else data.calc_window_size(dtype_in, for_emu=for_emu),
+            window_size=window_size,
             voltage_uV=round(data.voltage_mV * 10**3),
             voltage_min_uV=round(data.voltage_min_mV * 10**3),
             voltage_max_uV=round(data.voltage_max_mV * 10**3),
-            voltage_step_uV=round(data.voltage_step_mV * 10**3),
+            voltage_step_uV=round(voltage_step_mV * 10**3),
             current_limit_nA=round(data.current_limit_uA * 10**3),
             setpoint_n8=round(min(255, data.setpoint_n * 2**8)),
             interval_n=round(interval_ms * samplerate_sps_default * 1e-3),

{shepherd_core-2024.11.1 → shepherd_core-2024.11.3}/shepherd_core/data_models/experiment/__init__.py

@@ -14,13 +14,11 @@ from .target_config import TargetConfig
 
 __all__ = [
     "Experiment",
-    "TargetConfig",
-    # Features
-    "PowerTracing",
-    "GpioTracing",
     "GpioActuation",
     "GpioEvent",
-    "SystemLogging",
-    # Enums
     "GpioLevel",
+    "GpioTracing",
+    "PowerTracing",
+    "SystemLogging",
+    "TargetConfig",
 ]

{shepherd_core-2024.11.1 → shepherd_core-2024.11.3}/shepherd_core/data_models/task/__init__.py

@@ -22,18 +22,15 @@ from .programming import ProgrammingTask
 from .testbed_tasks import TestbedTasks
 
 __all__ = [
-    # Hierarchical Order
-    "TestbedTasks",
-    "ObserverTasks",
-    "FirmwareModTask",
-    "ProgrammingTask",
+    "Compression",
     "EmulationTask",
+    "FirmwareModTask",
     "HarvestTask",
-    # Enums
-    "Compression",
-    # helper functions
-    "prepare_task",
+    "ObserverTasks",
+    "ProgrammingTask",
+    "TestbedTasks",
     "extract_tasks",
+    "prepare_task",
 ]
 
 

{shepherd_core-2024.11.1 → shepherd_core-2024.11.3}/shepherd_core/data_models/testbed/__init__.py

@@ -16,17 +16,15 @@ from .target import Target
 from .testbed import Testbed
 
 __all__ = [
-    "Testbed",
-    "Observer",
-    "Cape",
-    "Target",
-    "MCU",
     "GPIO",
-    # enums
-    "ProgrammerProtocol",
+    "MCU",
+    "Cape",
     "Direction",
-    "TargetPort",
-    # custom types
     "IdInt16",
     "MACStr",
+    "Observer",
+    "ProgrammerProtocol",
+    "Target",
+    "TargetPort",
+    "Testbed",
 ]

{shepherd_core-2024.11.1 → shepherd_core-2024.11.3}/shepherd_core/data_models/testbed/observer_fixture.yaml

@@ -14,8 +14,8 @@
     latitude: 0
     cape:
       name: cape53
-    target_a:
-      name: nRF52_FRAM_018
+#    target_a:
+#      name: nRF52_FRAM_018
     created: 2022-12-12 12:12:12
     active: false
 - datatype: observer
@@ -24,13 +24,13 @@
     name: sheep01
     ip: 192.168.165.201
     mac: 18:62:E4:E4:41:8D
-    room: II70
-    eth_port: B22
-    description: mid-mid in room
+    room: II69
+    eth_port: B14
+    description: lower mid on east-side
     cape:
       name: cape51
     target_a:
-      name: nRF52_FRAM_001
+      name: nRF52_FRAM_1392_386
     created: 2023-09-22 12:12:12
 - datatype: observer
   parameters:
@@ -44,7 +44,7 @@
     cape:
       name: cape52
     target_a:
-      name: nRF52_FRAM_002
+      name: nRF52_FRAM_1392_378
     created: 2023-09-22 12:12:12
 - datatype: observer
   parameters:
@@ -57,9 +57,10 @@
     description: north-east-corner
     cape:
       name: cape63
-    target_a:
-      name: nRF52_FRAM_003
+#    target_a:
+#      name:
     created: 2023-09-22 12:12:12
+    active: false
 - datatype: observer
   parameters:
     id: 4
@@ -72,7 +73,7 @@
     cape:
       name: cape54
     target_a:
-      name: nRF52_FRAM_004
+      name: nRF52_FRAM_1392_395
     created: 2023-09-22 12:12:12
 - datatype: observer
   parameters:
@@ -86,7 +87,7 @@
     cape:
       name: cape55
     target_a:
-      name: nRF52_FRAM_011
+      name: nRF52_FRAM_1392_393
     target_b:
       name: target_nRF52_01  # ONLY VIRTUAL - for unittests
     created: 2023-09-22 12:12:12
@@ -102,7 +103,7 @@
     cape:
       name: cape56
     target_a:
-      name: nRF52_FRAM_017  # TODO: not validated
+      name: nRF52_FRAM_1392_396
     created: 2023-09-22 12:12:12
 - datatype: observer
   parameters:
@@ -116,7 +117,7 @@
     cape:
       name: cape57
     target_a:
-      name: nRF52_FRAM_008
+      name: nRF52_FRAM_1392_387
     created: 2023-09-22 12:12:12
 - datatype: observer
   parameters:
@@ -129,8 +130,8 @@
     description: north-east-corner
     cape:
       name: cape58
-    target_a:
-      name: nRF52_FRAM_016
+#    target_a:
+#      name:
     created: 2023-09-22 12:12:12
     active: false  # TODO: cape is broken for now
 - datatype: observer
@@ -145,7 +146,7 @@
     cape:
       name: cape65
     target_a:
-      name: nRF52_FRAM_009  # TODO: not validated
+      name: nRF52_FRAM_1392_385
     created: 2023-09-22 12:12:12
 - datatype: observer
   parameters:
@@ -159,7 +160,7 @@
     cape:
       name: cape59
     target_a:
-      name: nRF52_FRAM_010
+      name: nRF52_FRAM_1392_377
     created: 2023-09-22 12:12:12
 - datatype: observer
   parameters:
@@ -167,14 +168,15 @@
     name: sheep11
     ip: 192.168.165.211
     mac: 18:62:E4:E4:0E:5D
-    room: II69
-    eth_port: B14
-    description: lower mid on east-side
+    room: tbd
+    eth_port: tbd
+    description: tbd
     cape:
       name: cape61
-    target_a:
-      name: nRF52_FRAM_007
+#    target_a:
+#      name:
     created: 2023-09-22 12:12:12
+    active: false
 - datatype: observer
   parameters:
     id: 12
@@ -187,7 +189,7 @@
     cape:
       name: cape62
     target_a:
-      name: nRF52_FRAM_014
+      name: nRF52_FRAM_1392_384
     created: 2023-09-22 12:12:12
 - datatype: observer
   parameters:
@@ -202,7 +204,7 @@
     cape:
       name: cape60
     target_a:
-      name: nRF52_FRAM_005
+      name: nRF52_FRAM_1392_379
     created: 2023-09-22 12:12:12
 - datatype: observer
   parameters:
@@ -217,5 +219,5 @@
     cape:
       name: cape64
     target_a:
-      name: nRF52_FRAM_006
+      name: nRF52_FRAM_1392_390
     created: 2023-09-22 12:12:12

shepherd_core-2024.11.1/shepherd_core/data_models/testbed/target_fixture.yaml → shepherd_core-2024.11.3/shepherd_core/data_models/testbed/target_fixture.old1

@@ -3,7 +3,7 @@
 # https://github.com/orgua/shepherd_v2_planning/blob/main/doc_testbed/Target_pre-deployment-tests.xlsx
 - datatype: target
   parameters:
-    id: 6  # Outer ID - selected by user - can be rearranged
+    id: 6  # Outer ID - selected by user for XP - can be rearranged
     name: nRF52_FRAM_001  # inner ID - used to link all parts together
     version: v1.0
     description: nRF52 as MCU + Radio, MSP430FR as SPI-FRAM or additional MCU

shepherd_core-2024.11.3/shepherd_core/data_models/testbed/target_fixture.yaml

@@ -0,0 +1,163 @@
+---
+# more human-readable test-protocol @
+# https://github.com/orgua/shepherd_v2_planning/blob/main/doc_testbed/Target_pre-deployment-tests.xlsx
+- datatype: target
+  parameters:
+    id: 2  # Outer ID - selected by user for XP - can be rearranged
+    name: nRF52_FRAM_1392_377  # inner ID - used to link all parts together
+    version: v1.3
+    description: nRF52 as MCU + Radio, MSP430FR as SPI-FRAM or additional MCU
+    comment: slight scratches from manufacturing
+    created: 2024-11-29
+    mcu1:
+      name: nRF52
+    mcu2:
+      name: MSP430FR
+- datatype: target
+  parameters:
+    inherit_from: nRF52_FRAM_1392_377
+    id: 8
+    name: nRF52_FRAM_1392_378
+- datatype: target
+  parameters:
+    inherit_from: nRF52_FRAM_1392_377
+    id: 9
+    name: nRF52_FRAM_1392_379
+- datatype: target
+  parameters:
+    inherit_from: nRF52_FRAM_1392_377
+    id: 1392380
+    name: nRF52_FRAM_1392_380
+    comment: msp fails to program
+    active: false
+- datatype: target
+  parameters:
+    inherit_from: nRF52_FRAM_1392_377
+    id: 1392381
+    name: nRF52_FRAM_1392_381
+    comment: nrf failed to program in testbed (but was fine before)
+- datatype: target
+  parameters:
+    inherit_from: nRF52_FRAM_1392_377
+    id: 1392382
+    name: nRF52_FRAM_1392_382
+    comment: msp fails to program
+    active: false
+- datatype: target
+  parameters:
+    inherit_from: nRF52_FRAM_1392_377
+    id: 1392383
+    name: nRF52_FRAM_1392_383
+    comment: nrf failed to program in testbed (but was fine before)
+- datatype: target
+  parameters:
+    inherit_from: nRF52_FRAM_1392_377
+    id: 4
+    name: nRF52_FRAM_1392_384
+- datatype: target
+  parameters:
+    inherit_from: nRF52_FRAM_1392_377
+    id: 5
+    name: nRF52_FRAM_1392_385
+- datatype: target
+  parameters:
+    inherit_from: nRF52_FRAM_1392_377
+    id: 6
+    name: nRF52_FRAM_1392_386
+- datatype: target
+  parameters:
+    inherit_from: nRF52_FRAM_1392_377
+    id: 7
+    name: nRF52_FRAM_1392_387
+- datatype: target
+  parameters:
+    inherit_from: nRF52_FRAM_1392_377
+    id: 1392388
+    name: nRF52_FRAM_1392_388
+    comment: msp fails to program, msp removed, in darmstadt
+    mcu2: null
+    active: false
+- datatype: target
+  parameters:
+    inherit_from: nRF52_FRAM_1392_377
+    id: 1392389
+    name: nRF52_FRAM_1392_389
+    comment: msp fails to program, msp removed, in darmstadt
+    mcu2: null
+    active: false
+- datatype: target
+  parameters:
+    inherit_from: nRF52_FRAM_1392_377
+    id: 10
+    name: nRF52_FRAM_1392_390
+- datatype: target
+  parameters:
+    inherit_from: nRF52_FRAM_1392_377
+    id: 1392391
+    name: nRF52_FRAM_1392_391
+    comment: nrf failed to program in testbed (but was fine before)
+- datatype: target
+  parameters:
+    inherit_from: nRF52_FRAM_1392_377
+    id: 1392392
+    name: nRF52_FRAM_1392_392
+    comment: msp fails to program
+    active: false
+- datatype: target
+  parameters:
+    inherit_from: nRF52_FRAM_1392_377
+    id: 1
+    name: nRF52_FRAM_1392_393
+- datatype: target
+  parameters:
+    inherit_from: nRF52_FRAM_1392_377
+    id: 1392394
+    name: nRF52_FRAM_1392_394
+    comment: msp fails to program
+    active: false
+- datatype: target
+  parameters:
+    inherit_from: nRF52_FRAM_1392_377
+    id: 3
+    name: nRF52_FRAM_1392_395
+    comment: initial test unit
+- datatype: target
+  parameters:
+    inherit_from: nRF52_FRAM_1392_377
+    id: 11
+    name: nRF52_FRAM_1392_396
+- datatype: target
+  parameters:
+    inherit_from: nRF52_FRAM_1392_377
+    id: 1392397
+    name: nRF52_FRAM_1392_397
+- datatype: target
+  parameters:
+    inherit_from: nRF52_FRAM_1392_377
+    id: 1392398
+    name: nRF52_FRAM_1392_398
+- datatype: target
+  parameters:
+    inherit_from: nRF52_FRAM_1392_377
+    id: 1392399
+    name: nRF52_FRAM_1392_399
+    comment: LabPrototype
+- datatype: target
+  parameters:
+    inherit_from: nRF52_FRAM_1392_377
+    id: 1392400
+    name: nRF52_FRAM_1392_400
+    comment: in darmstadt
+
+
+- datatype: target
+  parameters:
+    id: 1001
+    name: target_nRF52_01
+    version: v2.1r0
+    description: single target PCB, v2.1r0
+    comment: ONLY VIRTUAL - NOT REAL - for unittests
+    mcu1:
+      name: nRF52
+    mcu2: null
+    created: 2022-12-12 12:12:12

{shepherd_core-2024.11.1 → shepherd_core-2024.11.3}/shepherd_core/data_models/testbed/testbed_fixture.yaml

@@ -11,15 +11,15 @@
     observers:
       - name: sheep01
       - name: sheep02
-      - name: sheep03
+#      - name: sheep03
       - name: sheep04
       - name: sheep05
       - name: sheep06
       - name: sheep07
-      - name: sheep08
+#      - name: sheep08
       - name: sheep09
       - name: sheep10
-      - name: sheep11
+#      - name: sheep11
       - name: sheep12
       - name: sheep13
       - name: sheep14

{shepherd_core-2024.11.1 → shepherd_core-2024.11.3}/shepherd_core/fw_tools/__init__.py

@@ -53,28 +53,25 @@ from .validation import is_hex_msp430
 from .validation import is_hex_nrf52
 
 __all__ = [
-    # patcher
-    "read_uid",
-    "modify_uid",
-    "modify_symbol_value",
-    "find_symbol",
-    "read_symbol",
-    "read_arch",
-    # converter
-    "elf_to_hex",
-    "file_to_base64",
     "base64_to_file",
-    "file_to_hash",
     "base64_to_hash",
+    "determine_arch",
+    "determine_type",
+    "elf_to_hex",
     "extract_firmware",
+    "file_to_base64",
+    "file_to_hash",
+    "find_symbol",
     "firmware_to_hex",
-    # validation
-    "is_hex",
-    "is_hex_msp430",
-    "is_hex_nrf52",
     "is_elf",
     "is_elf_msp430",
     "is_elf_nrf52",
-    "determine_type",
-    "determine_arch",
+    "is_hex",
+    "is_hex_msp430",
+    "is_hex_nrf52",
+    "modify_symbol_value",
+    "modify_uid",
+    "read_arch",
+    "read_symbol",
+    "read_uid",
 ]

{shepherd_core-2024.11.1 → shepherd_core-2024.11.3}/shepherd_core/reader.py

@@ -270,6 +270,26 @@ class Reader:
         else:
             return None
 
+    def get_voltage_step(self) -> Optional[float]:
+        """Informs about the voltage step (in volts) used during harvesting the ivcurve.
+
+        Options for figuring out the real step:
+        - look into config (if available)
+        - analyze recorded data for most often used delta
+        - calculate with 'steps_n * (1 + wait_cycles)' (done for calculating window_size)
+        """
+        voltage_step: Optional[float] = (
+            self.get_config().get("virtual_harvester", {}).get("voltage_step_mV", None)
+        )
+        if voltage_step is None:
+            dsv = self.ds_voltage[0:2000]
+            diffs_np = np.unique(dsv[1:] - dsv[0:-1], return_counts=False)
+            diffs_ls = [_e for _e in list(np.array(diffs_np)) if _e > 0]
+            voltage_step = min(diffs_ls)
+        if voltage_step is not None:
+            voltage_step = 1e-3 * voltage_step
+        return voltage_step
+
     def get_hrv_config(self) -> dict:
         """Essential info for harvester.
 
@@ -278,6 +298,7 @@ class Reader:
         return {
             "datatype": self.get_datatype(),
             "window_samples": self.get_window_samples(),
+            "voltage_step_V": self.get_voltage_step(),
         }
 
     def is_valid(self) -> bool:

{shepherd_core-2024.11.1 → shepherd_core-2024.11.3}/shepherd_core/version.py

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

{shepherd_core-2024.11.1 → shepherd_core-2024.11.3}/shepherd_core/vsource/virtual_harvester_simulation.py

@@ -47,6 +47,7 @@ def simulate_harvester(
         for_emu=True,
         dtype_in=file_inp.get_datatype(),
         window_size=file_inp.get_window_samples(),
+        voltage_step_V=file_inp.get_voltage_step(),
     )
     hrv = VirtualHarvesterModel(hrv_pru)
     e_out_Ws = 0.0

{shepherd_core-2024.11.1 → shepherd_core-2024.11.3}/shepherd_core/vsource/virtual_source_model.py

@@ -31,6 +31,7 @@ class VirtualSourceModel:
         cal_emu: CalibrationEmulator,
         dtype_in: EnergyDType = EnergyDType.ivsample,
         window_size: Optional[int] = None,
+        voltage_step_V: Optional[float] = None,
         *,
         log_intermediate: bool = False,
     ) -> None:
@@ -50,6 +51,7 @@ class VirtualSourceModel:
             for_emu=True,
             dtype_in=dtype_in,
             window_size=window_size,
+            voltage_step_V=voltage_step_V,
         )
 
         self.hrv: VirtualHarvesterModel = VirtualHarvesterModel(hrv_config)

{shepherd_core-2024.11.1 → shepherd_core-2024.11.3}/shepherd_core/vsource/virtual_source_simulation.py

@@ -56,6 +56,7 @@ def simulate_source(
         dtype_in=file_inp.get_datatype(),
         log_intermediate=False,
         window_size=file_inp.get_window_samples(),
+        voltage_step_V=file_inp.get_voltage_step(),
     )
     i_out_nA = 0
     e_out_Ws = 0.0

{shepherd_core-2024.11.1 → shepherd_core-2024.11.3}/shepherd_core.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: shepherd_core
-Version: 2024.11.1
+Version: 2024.11.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>