shepherd-core 2025.4.1__py3-none-any.whl → 2025.5.2__py3-none-any.whl

shepherd_core/calibration_hw_def.py

@@ -10,26 +10,26 @@ currently configured for cape v2.4c
 """
 
 # both current channels have a 0.1 % shunt resistance of
-R_SHT = 2.0  # [ohm]
+R_SHT: float = 2.0  # [ohm]
 # the instrumentation amplifiers are configured for gain of
-G_INST_AMP = 48  # [n]
+G_INST_AMP: int = 48  # [n]
 # we use the ADC's internal reference with
-V_REF_ADC = 4.096  # [V]
+V_REF_ADC: float = 4.096  # [V]
 # range of current channels is
-G_ADC_I = 1.25  # [gain / V_REF]
+G_ADC_I: float = 1.25  # [gain / V_REF]
 # range of voltage channels is
-G_ADC_V = 1.25  # [gain / V_REF]
+G_ADC_V: float = 1.25  # [gain / V_REF]
 # bit resolution of ADC
-M_ADC = 18  # [bit]
+M_ADC: int = 18  # [bit]
 # DACs use internal reference with
-V_REF_DAC = 2.5  # [V]
+V_REF_DAC: float = 2.5  # [V]
 # gain of DAC is set to
-G_DAC = 2  # [n]
+G_DAC: int = 2  # [n]
 # bit resolution of DAC
-M_DAC = 16  # [bit]
+M_DAC: int = 16  # [bit]
 # DERIVED VARIABLES
-RAW_MAX_ADC = 2**M_ADC - 1
-RAW_MAX_DAC = 2**M_DAC - 1
+RAW_MAX_ADC: int = 2**M_ADC - 1
+RAW_MAX_DAC: int = 2**M_DAC - 1
 
 
 def adc_current_to_raw(current: float, *, limited: bool = True) -> int:

shepherd_core/commons.py

@@ -1,8 +1,8 @@
 """Container for commonly shared constants."""
 
-samplerate_sps_default: int = 100_000
+SAMPLERATE_SPS_DEFAULT: int = 100_000
 
-uid_str_default: str = "SHEPHERD_NODE_ID"
-uid_len_default: int = 2
+UID_NAME: str = "SHEPHERD_NODE_ID"
+UID_SIZE: int = 2
 
-testbed_server_default: str = "http://127.0.0.1:8000/shepherd"
+TESTBED_SERVER_URI: str = "http://127.0.0.1:8000/shepherd"

shepherd_core/data_models/__init__.py

@@ -31,6 +31,7 @@ from .experiment.observer_features import GpioLevel
 from .experiment.observer_features import GpioTracing
 from .experiment.observer_features import PowerTracing
 from .experiment.observer_features import SystemLogging
+from .experiment.observer_features import UartTracing
 from .experiment.target_config import TargetConfig
 
 __all__ = [
@@ -54,6 +55,7 @@ __all__ = [
     "ShpModel",
     "SystemLogging",
     "TargetConfig",
+    "UartTracing",
     "VirtualHarvesterConfig",
     "VirtualSourceConfig",
     "Wrapper",

shepherd_core/data_models/base/cal_measurement.py

@@ -1,13 +1,12 @@
 """Models for the process of calibration a device by measurements."""
 
-from typing import List
+from typing import Annotated
 from typing import Optional
 
 import numpy as np
 from pydantic import Field
 from pydantic import PositiveFloat
 from pydantic import validate_call
-from typing_extensions import Annotated
 
 from .calibration import CalibrationCape
 from .calibration import CalibrationEmulator
@@ -24,7 +23,7 @@ class CalMeasurementPair(ShpModel):
     reference_si: float = 0
 
 
-CalMeasPairs = Annotated[List[CalMeasurementPair], Field(min_length=2)]
+CalMeasPairs = Annotated[list[CalMeasurementPair], Field(min_length=2)]
 
 
 @validate_call
@@ -37,16 +36,16 @@ def meas_to_cal(data: CalMeasPairs, component: str) -> CalibrationPair:
         y[i] = pair.reference_si
 
     model = np.polyfit(x, y, 1)
-    offset = model[1]
-    gain = model[0]
+    offset: float = float(model[1])
+    gain: float = float(model[0])
 
     # r-squared, Pearson correlation coefficient
-    p = np.poly1d(model)
-    yhat = p(x)
-    ybar = np.sum(y) / len(y)
-    ssreg = np.sum((yhat - ybar) ** 2)
-    sstot = np.sum((y - ybar) ** 2)
-    rval = ssreg / sstot
+    _p = np.poly1d(model)
+    yhat = _p(x)
+    ybar: float = np.sum(y) / len(y)
+    ssreg: float = np.sum((yhat - ybar) ** 2)
+    sstot: float = np.sum((y - ybar) ** 2)
+    rval: float = ssreg / sstot
 
     if rval < 0.999:
         msg = (

shepherd_core/data_models/base/calibration.py

@@ -1,11 +1,11 @@
 """Models for the calibration-data to convert between raw & SI-Values."""
 
 import struct
+from collections.abc import Generator
+from collections.abc import Mapping
+from collections.abc import Sequence
 from typing import Callable
-from typing import Generator
-from typing import Mapping
 from typing import Optional
-from typing import Sequence
 from typing import TypeVar
 from typing import Union
 
@@ -18,9 +18,10 @@ from pydantic import constr
 from pydantic import validate_call
 from typing_extensions import Self
 
-from ...calibration_hw_def import adc_current_to_raw
-from ...calibration_hw_def import adc_voltage_to_raw
-from ...calibration_hw_def import dac_voltage_to_raw
+from shepherd_core.calibration_hw_def import adc_current_to_raw
+from shepherd_core.calibration_hw_def import adc_voltage_to_raw
+from shepherd_core.calibration_hw_def import dac_voltage_to_raw
+
 from .shepherd import ShpModel
 from .timezone import local_iso_date
 

shepherd_core/data_models/base/content.py

@@ -2,6 +2,7 @@
 
 import hashlib
 from datetime import datetime
+from typing import Annotated
 from typing import Optional
 from typing import Union
 from uuid import uuid4
@@ -10,7 +11,6 @@ from pydantic import UUID4
 from pydantic import Field
 from pydantic import StringConstraints
 from pydantic import model_validator
-from typing_extensions import Annotated
 from typing_extensions import Self
 from typing_extensions import deprecated
 

shepherd_core/data_models/base/shepherd.py

@@ -2,11 +2,11 @@
 
 import hashlib
 import pathlib
+from collections.abc import Generator
 from datetime import timedelta
 from ipaddress import IPv4Address
 from pathlib import Path
 from typing import Any
-from typing import Generator
 from typing import Optional
 from typing import Union
 from uuid import UUID
@@ -15,27 +15,26 @@ import yaml
 from pydantic import BaseModel
 from pydantic import ConfigDict
 from typing_extensions import Self
-from yaml import Dumper
+from yaml import Node
 from yaml import SafeDumper
-from yaml import ScalarNode
 
 from .timezone import local_now
 from .wrapper import Wrapper
 
 
 def path2str(
-    dumper: Dumper, data: Union[pathlib.Path, pathlib.WindowsPath, pathlib.PosixPath]
-) -> ScalarNode:
+    dumper: SafeDumper, data: Union[pathlib.Path, pathlib.WindowsPath, pathlib.PosixPath]
+) -> Node:
     """Add a yaml-representation for a specific datatype."""
     return dumper.represent_scalar("tag:yaml.org,2002:str", str(data.as_posix()))
 
 
-def time2int(dumper: Dumper, data: timedelta) -> ScalarNode:
+def time2int(dumper: SafeDumper, data: timedelta) -> Node:
     """Add a yaml-representation for a specific datatype."""
     return dumper.represent_scalar("tag:yaml.org,2002:int", str(int(data.total_seconds())))
 
 
-def generic2str(dumper: Dumper, data: Any) -> ScalarNode:
+def generic2str(dumper: SafeDumper, data: Any) -> Node:
     """Add a yaml-representation for a specific datatype."""
     return dumper.represent_scalar("tag:yaml.org,2002:str", str(data))
 

shepherd_core/data_models/base/wrapper.py

@@ -1,13 +1,13 @@
 """Wrapper-related ecosystem for transferring models."""
 
 from datetime import datetime
+from typing import Annotated
 from typing import Optional
 
 from pydantic import BaseModel
 from pydantic import StringConstraints
-from typing_extensions import Annotated
 
-from ...version import version
+from shepherd_core.version import version
 
 SafeStrClone = Annotated[str, StringConstraints(pattern=r"^[ -~]+$")]
 # ⤷ copy avoids circular import

shepherd_core/data_models/content/_external_fixtures.yaml

@@ -1,5 +1,5 @@
 - datatype: EnergyEnvironment
-  created: 2024-02-25 12:45:58.488609+02:00
+  created: 2025-05-12 17:28:39.756999+02:00
   parameters:
     id: 2639560972524229652
     name: eenv_static_2000mV_10mA_3600s
@@ -22,7 +22,7 @@
     indoor: true
     location: Lab-VSrc
 - datatype: EnergyEnvironment
-  created: 2024-02-25 12:45:58.497654+02:00
+  created: 2025-05-12 17:28:39.764595+02:00
   parameters:
     id: 9823394105967169626
     name: eenv_static_2000mV_1mA_3600s
@@ -45,7 +45,7 @@
     indoor: true
     location: Lab-VSrc
 - datatype: EnergyEnvironment
-  created: 2024-02-25 12:45:58.506739+02:00
+  created: 2025-05-12 17:28:39.772144+02:00
   parameters:
     id: 3900615675169501222
     name: eenv_static_2000mV_50mA_3600s
@@ -68,7 +68,7 @@
     indoor: true
     location: Lab-VSrc
 - datatype: EnergyEnvironment
-  created: 2024-02-25 12:45:58.515790+02:00
+  created: 2025-05-12 17:28:39.779737+02:00
   parameters:
     id: 14796673729431137386
     name: eenv_static_2000mV_5mA_3600s
@@ -91,7 +91,7 @@
     indoor: true
     location: Lab-VSrc
 - datatype: EnergyEnvironment
-  created: 2024-02-25 12:45:58.524761+02:00
+  created: 2025-05-12 17:28:39.787329+02:00
   parameters:
     id: 6648482606607441403
     name: eenv_static_3000mV_10mA_3600s
@@ -114,7 +114,7 @@
     indoor: true
     location: Lab-VSrc
 - datatype: EnergyEnvironment
-  created: 2024-02-25 12:45:58.533513+02:00
+  created: 2025-05-12 17:28:39.794922+02:00
   parameters:
     id: 13566000951043177991
     name: eenv_static_3000mV_1mA_3600s
@@ -137,7 +137,7 @@
     indoor: true
     location: Lab-VSrc
 - datatype: EnergyEnvironment
-  created: 2024-02-25 12:45:58.542278+02:00
+  created: 2025-05-12 17:28:39.802410+02:00
   parameters:
     id: 7977778327156610158
     name: eenv_static_3000mV_50mA_3600s
@@ -160,7 +160,7 @@
     indoor: true
     location: Lab-VSrc
 - datatype: EnergyEnvironment
-  created: 2024-02-25 12:45:58.550974+02:00
+  created: 2025-05-12 17:28:39.810147+02:00
   parameters:
     id: 4900162978999238419
     name: eenv_static_3000mV_5mA_3600s
@@ -183,7 +183,7 @@
     indoor: true
     location: Lab-VSrc
 - datatype: Firmware
-  created: 2024-02-25 12:45:58.568363+02:00
+  created: 2025-05-12 17:28:39.825659+02:00
   parameters:
     id: 3000
     name: msp430_deep_sleep
@@ -198,10 +198,10 @@
     mcu:
       id: 1002
       name: MSP430FR
-      description: 16MHz Ultra-Low-Pwr MCU with 128 KB FRAM
+      description: 16MHz Ultra-Low-Pwr MCU with 256 KB FRAM
       comment: null
       platform: MSP430
-      core: MSP430FR5962
+      core: MSP430FR5994
       prog_protocol: SBW
       prog_voltage: 3.0
       prog_datarate: 500000
@@ -211,7 +211,7 @@
     data_hash: null
     data_local: false
 - datatype: Firmware
-  created: 2024-02-25 12:45:58.578594+02:00
+  created: 2025-05-12 17:28:39.834276+02:00
   parameters:
     id: 3001
     name: msp430_spi_fram
@@ -226,10 +226,10 @@
     mcu:
       id: 1002
       name: MSP430FR
-      description: 16MHz Ultra-Low-Pwr MCU with 128 KB FRAM
+      description: 16MHz Ultra-Low-Pwr MCU with 256 KB FRAM
       comment: null
       platform: MSP430
-      core: MSP430FR5962
+      core: MSP430FR5994
       prog_protocol: SBW
       prog_voltage: 3.0
       prog_datarate: 500000
@@ -239,7 +239,7 @@
     data_hash: null
     data_local: false
 - datatype: Firmware
-  created: 2024-02-25 12:45:58.589223+02:00
+  created: 2025-05-12 17:28:39.842993+02:00
   parameters:
     id: 3002
     name: msp430_testable
@@ -254,10 +254,10 @@
     mcu:
       id: 1002
       name: MSP430FR
-      description: 16MHz Ultra-Low-Pwr MCU with 128 KB FRAM
+      description: 16MHz Ultra-Low-Pwr MCU with 256 KB FRAM
       comment: null
       platform: MSP430
-      core: MSP430FR5962
+      core: MSP430FR5994
       prog_protocol: SBW
       prog_voltage: 3.0
       prog_datarate: 500000
@@ -267,7 +267,7 @@
     data_hash: null
     data_local: false
 - datatype: Firmware
-  created: 2024-02-25 12:45:58.599274+02:00
+  created: 2025-05-12 17:28:39.851412+02:00
   parameters:
     id: 7163917825449888392
     name: nrf52_deep_sleep
@@ -282,20 +282,20 @@
     mcu:
       id: 1001
       name: nRF52
-      description: Panasonic PAN1780, ENW-89854A1KF, Bluetooth 5 Low Energy Module
+      description: MCU with RF, 802.15.4, Bluetooth v5.0, 2.4GHz
       comment: null
       platform: nRF52
       core: nRF52840
       prog_protocol: SWD
       prog_voltage: 3.0
       prog_datarate: 500000
-      fw_name_default: nrf52_demo_rf
+      fw_name_default: nrf52_deep_sleep
     data: /var/shepherd/content/fw/nes_lab/nrf52_deep_sleep/build.elf
     data_type: path_elf
     data_hash: null
     data_local: false
 - datatype: Firmware
-  created: 2024-02-25 12:45:58.609313+02:00
+  created: 2025-05-12 17:28:39.859962+02:00
   parameters:
     id: 2000
     name: nrf52_demo_rf
@@ -310,20 +310,20 @@
     mcu:
       id: 1001
       name: nRF52
-      description: Panasonic PAN1780, ENW-89854A1KF, Bluetooth 5 Low Energy Module
+      description: MCU with RF, 802.15.4, Bluetooth v5.0, 2.4GHz
       comment: null
       platform: nRF52
       core: nRF52840
       prog_protocol: SWD
       prog_voltage: 3.0
       prog_datarate: 500000
-      fw_name_default: nrf52_demo_rf
+      fw_name_default: nrf52_deep_sleep
     data: /var/shepherd/content/fw/nes_lab/nrf52_demo_rf/build.elf
     data_type: path_elf
     data_hash: null
     data_local: false
 - datatype: Firmware
-  created: 2024-02-25 12:45:58.619155+02:00
+  created: 2025-05-12 17:28:39.868340+02:00
   parameters:
     id: 3174430733058172825
     name: nrf52_rf_survey
@@ -339,20 +339,20 @@
     mcu:
       id: 1001
       name: nRF52
-      description: Panasonic PAN1780, ENW-89854A1KF, Bluetooth 5 Low Energy Module
+      description: MCU with RF, 802.15.4, Bluetooth v5.0, 2.4GHz
       comment: null
       platform: nRF52
       core: nRF52840
       prog_protocol: SWD
       prog_voltage: 3.0
       prog_datarate: 500000
-      fw_name_default: nrf52_demo_rf
+      fw_name_default: nrf52_deep_sleep
     data: /var/shepherd/content/fw/nes_lab/nrf52_rf_survey/build.elf
     data_type: path_elf
     data_hash: null
     data_local: false
 - datatype: Firmware
-  created: 2024-02-25 12:45:58.628815+02:00
+  created: 2025-05-12 17:28:39.876819+02:00
   parameters:
     id: 16381936580724580968
     name: nrf52_rf_test
@@ -367,20 +367,20 @@
     mcu:
       id: 1001
       name: nRF52
-      description: Panasonic PAN1780, ENW-89854A1KF, Bluetooth 5 Low Energy Module
+      description: MCU with RF, 802.15.4, Bluetooth v5.0, 2.4GHz
       comment: null
       platform: nRF52
       core: nRF52840
       prog_protocol: SWD
       prog_voltage: 3.0
       prog_datarate: 500000
-      fw_name_default: nrf52_demo_rf
+      fw_name_default: nrf52_deep_sleep
     data: /var/shepherd/content/fw/nes_lab/nrf52_rf_test/build.elf
     data_type: path_elf
     data_hash: null
     data_local: false
 - datatype: Firmware
-  created: 2024-02-25 12:45:58.638812+02:00
+  created: 2025-05-12 17:28:39.885271+02:00
   parameters:
     id: 2002
     name: nrf52_testable
@@ -396,14 +396,14 @@
     mcu:
       id: 1001
       name: nRF52
-      description: Panasonic PAN1780, ENW-89854A1KF, Bluetooth 5 Low Energy Module
+      description: MCU with RF, 802.15.4, Bluetooth v5.0, 2.4GHz
       comment: null
       platform: nRF52
       core: nRF52840
       prog_protocol: SWD
       prog_voltage: 3.0
       prog_datarate: 500000
-      fw_name_default: nrf52_demo_rf
+      fw_name_default: nrf52_deep_sleep
     data: /var/shepherd/content/fw/nes_lab/nrf52_testable/build.elf
     data_type: path_elf
     data_hash: null

shepherd_core/data_models/content/energy_environment.py

@@ -2,20 +2,21 @@
 
 from enum import Enum
 from pathlib import Path
+from typing import Any
 from typing import Optional
 
 from pydantic import PositiveFloat
 from pydantic import model_validator
 
-from ...testbed_client import tb_client
-from ..base.content import ContentModel
+from shepherd_core.data_models.base.content import ContentModel
+from shepherd_core.testbed_client import tb_client
 
 
 class EnergyDType(str, Enum):
     """Data-Type-Options for energy environments."""
 
-    ivsample = ivsamples = "ivsample"
-    ivcurve = ivcurves = ivsurface = "ivcurve"
+    ivtrace = ivsample = ivsamples = "ivsample"
+    ivsurface = ivcurve = ivcurves = "ivcurve"
     isc_voc = "isc_voc"
 
 
@@ -46,7 +47,7 @@ class EnergyEnvironment(ContentModel):
 
     @model_validator(mode="before")
     @classmethod
-    def query_database(cls, values: dict) -> dict:
+    def query_database(cls, values: dict[str, Any]) -> dict[str, Any]:
         values, _ = tb_client.try_completing_model(cls.__name__, values)
         # TODO: figure out a way to crosscheck type with actual data
         return tb_client.fill_in_user_data(values)

shepherd_core/data_models/content/firmware.py

@@ -4,6 +4,8 @@ TODO: should be more generalized - currently only supports msp & nRF
 """
 
 from pathlib import Path
+from typing import Annotated
+from typing import Any
 from typing import Optional
 from typing import TypedDict
 from typing import Union
@@ -11,15 +13,15 @@ from typing import Union
 from pydantic import StringConstraints
 from pydantic import model_validator
 from pydantic import validate_call
-from typing_extensions import Annotated
 from typing_extensions import Self
 from typing_extensions import Unpack
 
-from ... import fw_tools
-from ...logger import logger
-from ...testbed_client import tb_client
-from ..base.content import ContentModel
-from ..testbed.mcu import MCU
+from shepherd_core import fw_tools
+from shepherd_core.data_models.base.content import ContentModel
+from shepherd_core.data_models.testbed.mcu import MCU
+from shepherd_core.logger import logger
+from shepherd_core.testbed_client import tb_client
+
 from .firmware_datatype import FirmwareDType
 
 suffix_to_DType: dict = {
@@ -64,7 +66,7 @@ class Firmware(ContentModel, title="Firmware of Target"):
 
     @model_validator(mode="before")
     @classmethod
-    def query_database(cls, values: dict) -> dict:
+    def query_database(cls, values: dict[str, Any]) -> dict[str, Any]:
         values, _ = tb_client.try_completing_model(cls.__name__, values)
         # crosscheck type with actual data
         _type = values.get("data_type")