shepherd-core 2024.9.1__tar.gz → 2024.11.2__tar.gz

{shepherd_core-2024.9.1 → shepherd_core-2024.11.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: shepherd_core
-Version: 2024.9.1
+Version: 2024.11.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.9.1 → shepherd_core-2024.11.2}/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.9.1 → shepherd_core-2024.11.2}/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.9.1 → shepherd_core-2024.11.2}/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.9.1 → shepherd_core-2024.11.2}/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.9.1 → shepherd_core-2024.11.2}/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-2024.9.1 → shepherd_core-2024.11.2}/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.9.1 → shepherd_core-2024.11.2}/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.9.1 → shepherd_core-2024.11.2}/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.9.1 → shepherd_core-2024.11.2}/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.9.1/shepherd_core/data_models/testbed/target_fixture.yaml → shepherd_core-2024.11.2/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.2/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.9.1 → shepherd_core-2024.11.2}/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.9.1 → shepherd_core-2024.11.2}/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.9.1 → shepherd_core-2024.11.2}/shepherd_core/version.py

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

{shepherd_core-2024.9.1 → shepherd_core-2024.11.2}/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-2024.9.1 → shepherd_core-2024.11.2}/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-2024.9.1 → shepherd_core-2024.11.2}/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