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

shepherd_core/__init__.py

@@ -26,20 +26,20 @@ from .writer import Writer
 __version__ = version
 
 __all__ = [
-    "Reader",
-    "Writer",
-    "get_verbose_level",
-    "increase_verbose_level",
-    "logger",
+    "Calc_t",
     "CalibrationCape",
-    "CalibrationSeries",
     "CalibrationEmulator",
     "CalibrationHarvester",
     "CalibrationPair",
-    "local_tz",
-    "local_now",
-    "Calc_t",
+    "CalibrationSeries",
     "Compression",
-    "WebClient",
     "Inventory",
+    "Reader",
+    "WebClient",
+    "Writer",
+    "get_verbose_level",
+    "increase_verbose_level",
+    "local_now",
+    "local_tz",
+    "logger",
 ]

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/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/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/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/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/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/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/data_models/testbed/target_fixture.old1

@@ -0,0 +1,137 @@
+---
+# 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: 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
+    comment: Test3 21nA sleep, msp-programming was flaky before -> monitor!
+    created: 2023-04-12
+    mcu1:
+      name: nRF52
+    mcu2:
+      name: MSP430FR
+- datatype: target
+  parameters:
+    inherit_from: nRF52_FRAM_001
+    id: 10
+    name: nRF52_FRAM_002
+    comment: Test3 21nA sleep
+- datatype: target
+  parameters:
+    inherit_from: nRF52_FRAM_001
+    id: 7
+    name: nRF52_FRAM_003
+    comment: Test3 21nA sleep
+- datatype: target
+  parameters:
+    inherit_from: nRF52_FRAM_001
+    id: 3
+    name: nRF52_FRAM_004
+    comment: Test3 21nA sleep
+- datatype: target
+  parameters:
+    inherit_from: nRF52_FRAM_001
+    id: 11
+    name: nRF52_FRAM_005
+    comment: Test3 21nA sleep, changed Antenna to lambda/4
+- datatype: target
+  parameters:
+    inherit_from: nRF52_FRAM_001
+    id: 12
+    name: nRF52_FRAM_006
+    comment: Test3 21nA sleep, changed Antenna to lambda/4
+- datatype: target
+  parameters:
+    inherit_from: nRF52_FRAM_001
+    id: 8
+    name: nRF52_FRAM_007
+    comment: msp-programming is failing -> defective, msp removed & changed Antenna to lambda/4
+    mcu2: null
+    active: true
+- datatype: target
+  parameters:
+    inherit_from: nRF52_FRAM_001
+    id: 9
+    name: nRF52_FRAM_008
+    comment: msp-programming is failing -> defective, msp removed & changed Antenna to lambda/4
+    mcu2: null
+    active: true
+- datatype: target
+  parameters:
+    inherit_from: nRF52_FRAM_001
+    id: 5
+    name: nRF52_FRAM_009
+    comment: Test3 21nA sleep
+- datatype: target
+  parameters:
+    inherit_from: nRF52_FRAM_001
+    id: 2
+    name: nRF52_FRAM_010
+    comment: Test3 21nA sleep
+- datatype: target
+  parameters:
+    inherit_from: nRF52_FRAM_001
+    id: 1
+    name: nRF52_FRAM_011
+    comment: Test3 21nA sleep, changed Antenna to lambda/4
+- datatype: target
+  parameters:
+    inherit_from: nRF52_FRAM_001
+    id: 1312
+    name: nRF52_FRAM_012
+    comment: msp-programming is failing -> defective, Antenna-Port destroyed
+    active: false
+- datatype: target
+  parameters:
+    inherit_from: nRF52_FRAM_001
+    id: 1313
+    name: nRF52_FRAM_013
+    comment: Test3 15nA sleep, Test1 fails - several cleanings -> defective
+    active: false
+- datatype: target
+  parameters:
+    inherit_from: nRF52_FRAM_001
+    id: 4
+    name: nRF52_FRAM_014
+    comment: Test3 21nA sleep
+- datatype: target
+  parameters:
+    inherit_from: nRF52_FRAM_001
+    id: 1315
+    name: nRF52_FRAM_015
+    comment: Test3 19nA sleep, Test1 fails - several cleanings - gpio error on nrf-side -> defective
+    active: false
+- datatype: target
+  parameters:
+    inherit_from: nRF52_FRAM_001
+    id: 666
+    name: nRF52_FRAM_016
+    comment: Test3 21nA sleep
+- datatype: target
+  parameters:
+    inherit_from: nRF52_FRAM_001
+    id: 13
+    name: nRF52_FRAM_017
+    comment: Test3 21nA sleep, nrf was miss-aligned -> hot air rework
+- datatype: target
+  parameters:
+    inherit_from: nRF52_FRAM_001
+    id: 18
+    name: nRF52_FRAM_018
+    comment: Test3 21nA sleep, nrf was miss-aligned -> hot air rework
+    description: LabPrototype
+
+- datatype: target
+  parameters:
+    id: 1001
+    name: target_nRF52_01
+    version: v2.1r0
+    description: single target PCB, v2.1r0
+    comment: ONLY VIRTUAL - NOT REAL
+    mcu1:
+      name: nRF52
+    mcu2: null
+    created: 2022-12-12 12:12:12

shepherd_core/data_models/testbed/target_fixture.yaml

@@ -3,126 +3,152 @@
 # 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
-    name: nRF52_FRAM_001  # inner ID - used to link all parts together
-    version: v1.0
+    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: Test3 21nA sleep, msp-programming was flaky before -> monitor!
-    created: 2023-04-12
+    comment: slight scratches from manufacturing
+    created: 2024-11-29
     mcu1:
       name: nRF52
     mcu2:
       name: MSP430FR
 - datatype: target
   parameters:
-    inherit_from: nRF52_FRAM_001
-    id: 10
-    name: nRF52_FRAM_002
-    comment: Test3 21nA sleep
+    inherit_from: nRF52_FRAM_1392_377
+    id: 8
+    name: nRF52_FRAM_1392_378
 - datatype: target
   parameters:
-    inherit_from: nRF52_FRAM_001
-    id: 7
-    name: nRF52_FRAM_003
-    comment: Test3 21nA sleep
+    inherit_from: nRF52_FRAM_1392_377
+    id: 9
+    name: nRF52_FRAM_1392_379
 - datatype: target
   parameters:
-    inherit_from: nRF52_FRAM_001
-    id: 3
-    name: nRF52_FRAM_004
-    comment: Test3 21nA sleep
+    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_001
-    id: 11
-    name: nRF52_FRAM_005
-    comment: Test3 21nA sleep, changed Antenna to lambda/4
+    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_001
-    id: 12
-    name: nRF52_FRAM_006
-    comment: Test3 21nA sleep, changed Antenna to lambda/4
+    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_001
-    id: 8
-    name: nRF52_FRAM_007
-    comment: msp-programming is failing -> defective, msp removed & changed Antenna to lambda/4
-    mcu2: null
-    active: true
+    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_001
-    id: 9
-    name: nRF52_FRAM_008
-    comment: msp-programming is failing -> defective, msp removed & changed Antenna to lambda/4
-    mcu2: null
-    active: true
+    inherit_from: nRF52_FRAM_1392_377
+    id: 4
+    name: nRF52_FRAM_1392_384
 - datatype: target
   parameters:
-    inherit_from: nRF52_FRAM_001
+    inherit_from: nRF52_FRAM_1392_377
     id: 5
-    name: nRF52_FRAM_009
-    comment: Test3 21nA sleep
+    name: nRF52_FRAM_1392_385
 - datatype: target
   parameters:
-    inherit_from: nRF52_FRAM_001
-    id: 2
-    name: nRF52_FRAM_010
-    comment: Test3 21nA sleep
+    inherit_from: nRF52_FRAM_1392_377
+    id: 6
+    name: nRF52_FRAM_1392_386
 - datatype: target
   parameters:
-    inherit_from: nRF52_FRAM_001
-    id: 1
-    name: nRF52_FRAM_011
-    comment: Test3 21nA sleep, changed Antenna to lambda/4
+    inherit_from: nRF52_FRAM_1392_377
+    id: 7
+    name: nRF52_FRAM_1392_387
 - datatype: target
   parameters:
-    inherit_from: nRF52_FRAM_001
-    id: 1312
-    name: nRF52_FRAM_012
-    comment: msp-programming is failing -> defective, Antenna-Port destroyed
+    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_001
-    id: 1313
-    name: nRF52_FRAM_013
-    comment: Test3 15nA sleep, Test1 fails - several cleanings -> defective
+    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_001
-    id: 4
-    name: nRF52_FRAM_014
-    comment: Test3 21nA sleep
+    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_001
-    id: 1315
-    name: nRF52_FRAM_015
-    comment: Test3 19nA sleep, Test1 fails - several cleanings - gpio error on nrf-side -> defective
+    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_001
-    id: 666
-    name: nRF52_FRAM_016
-    comment: Test3 21nA sleep
+    inherit_from: nRF52_FRAM_1392_377
+    id: 3
+    name: nRF52_FRAM_1392_395
+    comment: initial test unit
 - datatype: target
   parameters:
-    inherit_from: nRF52_FRAM_001
-    id: 13
-    name: nRF52_FRAM_017
-    comment: Test3 21nA sleep, nrf was miss-aligned -> hot air rework
+    inherit_from: nRF52_FRAM_1392_377
+    id: 11
+    name: nRF52_FRAM_1392_396
 - datatype: target
   parameters:
-    inherit_from: nRF52_FRAM_001
-    id: 18
-    name: nRF52_FRAM_018
-    comment: Test3 21nA sleep, nrf was miss-aligned -> hot air rework
-    description: LabPrototype
+    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:
@@ -130,7 +156,7 @@
     name: target_nRF52_01
     version: v2.1r0
     description: single target PCB, v2.1r0
-    comment: ONLY VIRTUAL - NOT REAL
+    comment: ONLY VIRTUAL - NOT REAL - for unittests
     mcu1:
       name: nRF52
     mcu2: null

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/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/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/testbed_client/__init__.py

@@ -5,7 +5,7 @@ from .client_web import WebClient
 from .user_model import User
 
 __all__ = [
-    "tb_client",
-    "WebClient",
     "User",
+    "WebClient",
+    "tb_client",
 ]

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/vsource/__init__.py

@@ -11,13 +11,13 @@ from .virtual_source_model import VirtualSourceModel
 from .virtual_source_simulation import simulate_source
 
 __all__ = [
+    "ConstantCurrentTarget",
+    "ConstantPowerTarget",
     "PruCalibration",
+    "ResistiveTarget",
     "VirtualConverterModel",
     "VirtualHarvesterModel",
     "VirtualSourceModel",
     "simulate_harvester",
     "simulate_source",
-    "ResistiveTarget",
-    "ConstantCurrentTarget",
-    "ConstantPowerTarget",
 ]

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/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/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.dist-info → shepherd_core-2024.11.3.dist-info}/METADATA

@@ -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>
@@ -33,27 +33,27 @@ Requires-Dist: h5py
 Requires-Dist: numpy
 Requires-Dist: pyYAML
 Requires-Dist: chromalog
-Requires-Dist: pydantic[email] >2.0.0
+Requires-Dist: pydantic[email]>2.0.0
 Requires-Dist: tqdm
 Requires-Dist: intelhex
 Requires-Dist: requests
 Requires-Dist: pyelftools
 Requires-Dist: zstandard
 Requires-Dist: typing-extensions
-Provides-Extra: dev
-Requires-Dist: twine ; extra == 'dev'
-Requires-Dist: pre-commit ; extra == 'dev'
-Requires-Dist: pyright ; extra == 'dev'
-Requires-Dist: ruff ; extra == 'dev'
-Requires-Dist: mypy ; extra == 'dev'
-Requires-Dist: types-PyYAML ; extra == 'dev'
 Provides-Extra: elf
-Requires-Dist: pwntools-elf-only ; extra == 'elf'
+Requires-Dist: pwntools-elf-only; extra == "elf"
 Provides-Extra: inventory
-Requires-Dist: psutil ; extra == 'inventory'
+Requires-Dist: psutil; extra == "inventory"
+Provides-Extra: dev
+Requires-Dist: twine; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: pyright; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: types-PyYAML; extra == "dev"
 Provides-Extra: test
-Requires-Dist: pytest ; extra == 'test'
-Requires-Dist: coverage ; extra == 'test'
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: coverage; extra == "test"
 
 # Core Library
 

{shepherd_core-2024.11.1.dist-info → shepherd_core-2024.11.3.dist-info}/RECORD

@@ -1,11 +1,11 @@
-shepherd_core/__init__.py,sha256=QyqENyf508XfZQ4vDU5o6UL9rmIqkf8kzwgTF9XU1-Y,1270
+shepherd_core/__init__.py,sha256=fCld2mcl0y0h6kRyPal3DP-sWXnKl_0aYWYBdg4QuUk,1270
 shepherd_core/calibration_hw_def.py,sha256=_nMzgNzSnYyqcLnVCGd4tfA2e0avUXbccjmNpFhiDgo,2830
 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=_cAEEjp9MalkLrnbibrPNp6zEr3U5KIC-gmZvPG5QqA,76
+shepherd_core/reader.py,sha256=OBjvvo-R_68RPAlgTWfYkNeIW-wEeHVcSzScxLhYhvg,28021
+shepherd_core/version.py,sha256=efgburSXJlcrRhiL0_hKDFmBgNSmAdHw7BRzTIN918M,76
 shepherd_core/writer.py,sha256=GMR-7vkOgpTNPoknBWsRsC7-b7iGMtT60-KtSKunNe8,14636
-shepherd_core/data_models/__init__.py,sha256=IVjKbT2Ilz5bev325EvAuuhd9LfQgQ1u7qKo6dhVA2k,1866
+shepherd_core/data_models/__init__.py,sha256=bnHSP_HBOYm4WuoiHs_vyiRsWlvkyDjsarMNfKedN-Q,1836
 shepherd_core/data_models/readme.md,sha256=1bdfEypY_0NMhXLxOPRnLAsFca0HuHdq7_01yEWxvUs,2470
 shepherd_core/data_models/virtual_source_doc.txt,sha256=KizMcfGKj7BnHIbaJHT7KeTF01SV__UXv01qV_DGHSs,6057
 shepherd_core/data_models/base/__init__.py,sha256=PSJ6acWViqBm0Eiom8DIgKfFVrp5lzYr8OsDvP79vwI,94
@@ -15,28 +15,28 @@ shepherd_core/data_models/base/content.py,sha256=13j7GSgT73xn27jgDP508thUEJR4U-n
 shepherd_core/data_models/base/shepherd.py,sha256=DNrx59o1VBuy_liJuUzZRzmTTYB73D_pUWiNyMQyjYY,6112
 shepherd_core/data_models/base/timezone.py,sha256=2T6E46hJ1DAvmqKfu6uIgCK3RSoAKjGXRyzYNaqKyjY,665
 shepherd_core/data_models/base/wrapper.py,sha256=Izp17HFCKNAS3TnWcPn3MM9fWdc3A-F7eDyAsYlyWCw,755
-shepherd_core/data_models/content/__init__.py,sha256=wVa5lw6bS-fBgeo-SWydg6rw8AsScxqNgDo81dzteaE,537
+shepherd_core/data_models/content/__init__.py,sha256=69aiNG0h5t1OF7HsLg_ke5eaQKsKyMK8o6Kfaby5vlY,525
 shepherd_core/data_models/content/_external_fixtures.yaml,sha256=0CH7YSWT_hzL-jcg4JjgN9ryQOzbS8S66_pd6GbMnHw,12259
 shepherd_core/data_models/content/energy_environment.py,sha256=WuXMkKqnibGzM2WeW1_m2DAsc0fDqE9CkBYYPSw-7eA,1540
 shepherd_core/data_models/content/energy_environment_fixture.yaml,sha256=UBXTdGT7MK98zx5w_RBCu-f9uNCKxRgiFBQFbmDUxPc,1301
 shepherd_core/data_models/content/firmware.py,sha256=MyEiaP6bkOm7i_oihDXTxHC7ajc5aqiIDLn7mhap6YY,5722
 shepherd_core/data_models/content/firmware_datatype.py,sha256=XPU9LOoT3h5qFOlE8WU0vAkw-vymNxzor9kVFyEqsWg,255
-shepherd_core/data_models/content/virtual_harvester.py,sha256=MXmSJ_nRp1mSzxfTNk60o9h5Yrp2lFMbLphUVSnNeNc,9999
+shepherd_core/data_models/content/virtual_harvester.py,sha256=cf-DrSacZsct9e8eGoR4PX7S7RXlbxQfJHVsLR9njlM,10749
 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=1o-31mGgn7eyCNidKoOUp9vZh3K4Al0kJgmz54Q2DAE,11191
-shepherd_core/data_models/experiment/__init__.py,sha256=9TE9_aSnCNRhagsIWLTE8XkyjyMGB7kEGdswl-296v0,645
+shepherd_core/data_models/experiment/__init__.py,sha256=lorsx0M-JWPIrt_UZfexsLwaITv5slFb3krBOt0idm8,618
 shepherd_core/data_models/experiment/experiment.py,sha256=wnn6T3czuh4rz6OSYtMltCTbRpPX55TLVAtQcKO7Uhg,4044
 shepherd_core/data_models/experiment/observer_features.py,sha256=qxnb7anuQz9ZW5IUlPdUXYPIl5U7O9uXkJqZtMnAb0Y,5156
 shepherd_core/data_models/experiment/target_config.py,sha256=XIsjbbo7yn_A4q3GMxWbiNzEGA0Kk5gH7-XfQQ7Kg0E,3674
-shepherd_core/data_models/task/__init__.py,sha256=rZLbgqX-dTWY4026-bqW-IWVHbA6C_xP9y0aeRze8FY,3374
+shepherd_core/data_models/task/__init__.py,sha256=qZPoLdqnU2ffqP08wUdXzf0MC5hEdv5X2_XOIui0MM8,3314
 shepherd_core/data_models/task/emulation.py,sha256=tLb5auHOgdoG-e4hFljAYT49z7lMEaiimOy4UVZONi4,6440
 shepherd_core/data_models/task/firmware_mod.py,sha256=Rw_TA1ykQ7abUd_U0snqZlpZyrS8Nx6f4BEax1Xnji0,2818
 shepherd_core/data_models/task/harvest.py,sha256=HHnqWwRsJupaZJxuohs7NrK6VaDyoRzGOaG2h9y3s1Y,3360
 shepherd_core/data_models/task/observer_tasks.py,sha256=XlH_-EGRrdodTn0c2pjGvpcauc0a9NOnLhysKw8iRwk,3511
 shepherd_core/data_models/task/programming.py,sha256=Mg9_AZHIdG01FheEJAifIRPSB3iZ0UJITf8zeg2jyws,2323
 shepherd_core/data_models/task/testbed_tasks.py,sha256=zvIitq0Ek1Ae7baWiBkSQN8nRugyw0N2P4SeVoj_QaY,2090
-shepherd_core/data_models/testbed/__init__.py,sha256=cL3swgijyIpZIW1vl51OVR2seAlWt6Ke9oB_cBkPniU,612
+shepherd_core/data_models/testbed/__init__.py,sha256=t9nwml5pbu7ZWghimOyZ8ujMIgnRgFkl23pNb5d_KdU,581
 shepherd_core/data_models/testbed/cape.py,sha256=D23ZKXpZRPIIOMn6LCoJrwHiRbSaYg-y7B6fAt1ap64,1246
 shepherd_core/data_models/testbed/cape_fixture.yaml,sha256=uwZxe6hsqvofn5tzg4sffjbVtTVUkextL1GCri_z2A4,2197
 shepherd_core/data_models/testbed/gpio.py,sha256=m4U8-KotpZbdSkRkXm2GqoADiubr_1-3BWOT1qlgQic,2195
@@ -44,14 +44,15 @@ shepherd_core/data_models/testbed/gpio_fixture.yaml,sha256=yXvoXAau2hancKi2yg1xI
 shepherd_core/data_models/testbed/mcu.py,sha256=pUyT8gwPcqh18I7FC6iE6gYYISo69TvDfuq2zSwfmxs,1375
 shepherd_core/data_models/testbed/mcu_fixture.yaml,sha256=lRZMLs27cTeERSFGkbMt5xgxbn11Gh9G1mQqOZK136I,522
 shepherd_core/data_models/testbed/observer.py,sha256=hlj6buDzUQKYnlhCJZyxnrAPYKoL4zq9y14sKtYofOU,3246
-shepherd_core/data_models/testbed/observer_fixture.yaml,sha256=w4VS6lTzaVs5IqWjkHanxcjDhIEydQPCV6z_DlsLFqA,4812
+shepherd_core/data_models/testbed/observer_fixture.yaml,sha256=jqAatTebWrShXBlhqkCUQIrtVqEjl7RVDR9mosS2LJQ,4807
 shepherd_core/data_models/testbed/target.py,sha256=KeJaLradQ3oHeeowCg_X0lDHDqyi3R3La0YPKC5Rv90,1838
-shepherd_core/data_models/testbed/target_fixture.yaml,sha256=6YbCV3aTtDUKzC40kPURq9nFwTjT97LNy7imOb_35sk,3668
+shepherd_core/data_models/testbed/target_fixture.old1,sha256=ivH9uTgC2Z4L_J4KDHAyIHZnB7iy9EUu1yM3M0s1lQQ,3675
+shepherd_core/data_models/testbed/target_fixture.yaml,sha256=LyOJa7yH17tHIGC25jlkLJ_DKnbFSoGhD-6Uh6q_HqQ,4132
 shepherd_core/data_models/testbed/testbed.py,sha256=0uJ3OwqCKDn78OCJOaMa2XWxTLF1ultjmpHVSx3LyhE,3695
-shepherd_core/data_models/testbed/testbed_fixture.yaml,sha256=9i2cmYRrHOHTJG9zp40h8h0LgO9DdrCJz8tyGdiQCzc,714
+shepherd_core/data_models/testbed/testbed_fixture.yaml,sha256=LaaU8mXLQboYWYNPpA3CWmMPy2w6T6cve6gLgDaA3l0,717
 shepherd_core/decoder_waveform/__init__.py,sha256=-ohGz0fA2tKxUJk4FAQXKtI93d6YGdy0CrkdhOod1QU,120
 shepherd_core/decoder_waveform/uart.py,sha256=sHsXHOsDU1j9zMSZO7CCMTMinT4U_S5NgsEkl1lJK1U,11029
-shepherd_core/fw_tools/__init__.py,sha256=_RZpgHsNN1Zhd-x0-A9aJPI3pjULKhR9iuR9eKPa8zQ,2137
+shepherd_core/fw_tools/__init__.py,sha256=D9GGj9TzLWZfPjG_iV2BsF-Q1TGTYTgEzWTUI5ReVAA,2090
 shepherd_core/fw_tools/converter.py,sha256=3igRT33tghrBCao5njuPmePS-Y_lSa6EUHvwCakMo2s,3539
 shepherd_core/fw_tools/converter_elf.py,sha256=GQDVqIqMW4twNMvZIV3sowFMezhs2TN-IYREjRP7Xt4,1089
 shepherd_core/fw_tools/patcher.py,sha256=D6MHaCvKRRVQYSZozODAp_l7UnqxVsvnulPzpkfXWW8,4108
@@ -60,21 +61,21 @@ shepherd_core/inventory/__init__.py,sha256=nRO11HG4eJ_FaXebSkE0dd1H6qvjrX5n3OQHO
 shepherd_core/inventory/python.py,sha256=OWNnyEt0IDPW9XGW-WloU0FExwgZzYNA05VpRj4cZGc,1250
 shepherd_core/inventory/system.py,sha256=jRzko9QNPLaBiG7urVaeqqvb3GtCEYRwc0DAghRkLVo,3159
 shepherd_core/inventory/target.py,sha256=Lq11j25tWieXheOxIDaQb-lc-2omxYVex5P6uGiLUyk,507
-shepherd_core/testbed_client/__init__.py,sha256=kV-_g1ZiopWg2Aoq0k7fPD0pDqHrMDVYnNOrMBBWgnY,234
+shepherd_core/testbed_client/__init__.py,sha256=QtbsBUzHwOoM6rk0qa21ywuz63YV7af1fwUtWW8Vg_4,234
 shepherd_core/testbed_client/cache_path.py,sha256=tS0er9on5fw8wddMCt1jkc2uyYOdSTvX_UmfmYJf6tY,445
 shepherd_core/testbed_client/client_abc_fix.py,sha256=BsSkpvJHURRejlS-YPF1f6QRPC_X0fYEsJpinzsx6Jc,4079
 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=GVB-FwuO2mvM15mGX9EQC1lbUmHMLmUEFGYkGmIngPM,771
+shepherd_core/vsource/__init__.py,sha256=vTvFWuJn4eurPNzEiMd15c1Rd6o3DTWzCfbhOomflZU,771
 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.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/vsource/virtual_harvester_simulation.py,sha256=MFT583s73BJZYyhcqgnDUGTPr9s_lN_lKafzJG6kueE,2457
+shepherd_core/vsource/virtual_source_model.py,sha256=9tiOzgrEgdEH5Uuhd8hjmmIkquNDuaNjLlblvInIlzg,3036
+shepherd_core/vsource/virtual_source_simulation.py,sha256=ZOnFd2uPawY2G1salCiLGx9o1OBG99_-EHBtDjx4ZUo,5140
+shepherd_core-2024.11.3.dist-info/METADATA,sha256=OBSLkOgbXMb_mhTym-Dk2p_GoPkGQyzMbYlaRhRhicU,7807
+shepherd_core-2024.11.3.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
+shepherd_core-2024.11.3.dist-info/top_level.txt,sha256=wy-t7HRBrKARZxa-Y8_j8d49oVHnulh-95K9ikxVhew,14
+shepherd_core-2024.11.3.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+shepherd_core-2024.11.3.dist-info/RECORD,,

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

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