shepherd-core 2025.6.4__py3-none-any.whl → 2025.10.1__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (45) hide show
  1. shepherd_core/data_models/__init__.py +4 -2
  2. shepherd_core/data_models/base/content.py +2 -0
  3. shepherd_core/data_models/content/__init__.py +4 -2
  4. shepherd_core/data_models/content/{virtual_harvester.py → virtual_harvester_config.py} +3 -3
  5. shepherd_core/data_models/content/{virtual_source.py → virtual_source_config.py} +82 -58
  6. shepherd_core/data_models/content/virtual_source_fixture.yaml +24 -24
  7. shepherd_core/data_models/content/virtual_storage_config.py +426 -0
  8. shepherd_core/data_models/content/virtual_storage_fixture_creator.py +267 -0
  9. shepherd_core/data_models/content/virtual_storage_fixture_ideal.yaml +637 -0
  10. shepherd_core/data_models/content/virtual_storage_fixture_lead.yaml +49 -0
  11. shepherd_core/data_models/content/virtual_storage_fixture_lipo.yaml +735 -0
  12. shepherd_core/data_models/content/virtual_storage_fixture_mlcc.yaml +200 -0
  13. shepherd_core/data_models/content/virtual_storage_fixture_param_experiments.py +151 -0
  14. shepherd_core/data_models/content/virtual_storage_fixture_super.yaml +150 -0
  15. shepherd_core/data_models/content/virtual_storage_fixture_tantal.yaml +550 -0
  16. shepherd_core/data_models/experiment/observer_features.py +8 -2
  17. shepherd_core/data_models/experiment/target_config.py +1 -1
  18. shepherd_core/data_models/task/emulation.py +9 -6
  19. shepherd_core/data_models/task/firmware_mod.py +1 -0
  20. shepherd_core/data_models/task/harvest.py +4 -4
  21. shepherd_core/data_models/task/observer_tasks.py +5 -2
  22. shepherd_core/data_models/task/programming.py +1 -0
  23. shepherd_core/data_models/task/testbed_tasks.py +6 -1
  24. shepherd_core/decoder_waveform/uart.py +2 -1
  25. shepherd_core/fw_tools/patcher.py +60 -34
  26. shepherd_core/fw_tools/validation.py +7 -1
  27. shepherd_core/inventory/system.py +1 -1
  28. shepherd_core/reader.py +4 -3
  29. shepherd_core/version.py +1 -1
  30. shepherd_core/vsource/__init__.py +4 -0
  31. shepherd_core/vsource/virtual_converter_model.py +27 -26
  32. shepherd_core/vsource/virtual_harvester_model.py +27 -19
  33. shepherd_core/vsource/virtual_harvester_simulation.py +38 -39
  34. shepherd_core/vsource/virtual_source_model.py +17 -13
  35. shepherd_core/vsource/virtual_source_simulation.py +71 -73
  36. shepherd_core/vsource/virtual_storage_model.py +164 -0
  37. shepherd_core/vsource/virtual_storage_model_fixed_point_math.py +58 -0
  38. shepherd_core/vsource/virtual_storage_models_kibam.py +449 -0
  39. shepherd_core/vsource/virtual_storage_simulator.py +104 -0
  40. {shepherd_core-2025.6.4.dist-info → shepherd_core-2025.10.1.dist-info}/METADATA +4 -6
  41. {shepherd_core-2025.6.4.dist-info → shepherd_core-2025.10.1.dist-info}/RECORD +44 -32
  42. shepherd_core/data_models/virtual_source_doc.txt +0 -207
  43. {shepherd_core-2025.6.4.dist-info → shepherd_core-2025.10.1.dist-info}/WHEEL +0 -0
  44. {shepherd_core-2025.6.4.dist-info → shepherd_core-2025.10.1.dist-info}/top_level.txt +0 -0
  45. {shepherd_core-2025.6.4.dist-info → shepherd_core-2025.10.1.dist-info}/zip-safe +0 -0
shepherd_core/data_models/content/virtual_storage_fixture_mlcc.yaml ADDED
@@ -0,0 +1,200 @@
1
+ - datatype: VirtualStorageConfig
2
+ comment: created by script 'virtual_storage_fixture_creator.py'
3
+ created: 2025-09-11 19:47:04.433082+02:00
4
+ parameters:
5
+ id: 419607010409477957
6
+ name: Capacitor_10uF_6.3V
7
+ description: MLCC-Capacitor with R_leak & R_series and planned DC-Bias-Effect,
8
+ R_leak = 9780.000 Ohm
9
+ comment: null
10
+ created: 2025-09-11 19:47:04.396971
11
+ updated_last: 2025-09-11 19:47:04.396972
12
+ owner: NES Lab
13
+ group: NES Lab
14
+ visible2group: true
15
+ visible2all: true
16
+ SoC_init: 0.8
17
+ q_As: 6.299999999999999e-05
18
+ p_VOC:
19
+ - 0.0
20
+ - 0.0
21
+ - 0.0
22
+ - 6.3
23
+ - 0.0
24
+ - 0.0
25
+ p_Rs:
26
+ - 0.0
27
+ - 0.0
28
+ - 0.0
29
+ - 0.0
30
+ - 0.0
31
+ - 0.0
32
+ p_RtS:
33
+ - 0.0
34
+ - 0.0
35
+ - 0.0
36
+ p_CtS:
37
+ - 0.0
38
+ - 0.0
39
+ - 0.0
40
+ p_RtL:
41
+ - 0.0
42
+ - 0.0
43
+ - 0.0
44
+ p_CtL:
45
+ - 0.0
46
+ - 0.0
47
+ - 0.0
48
+ p_rce: 1.0
49
+ kdash: 2.2250738585072014e-308
50
+ R_leak_Ohm: 9780000.0
51
+ - datatype: VirtualStorageConfig
52
+ comment: created by script 'virtual_storage_fixture_creator.py'
53
+ created: 2025-09-11 19:47:04.433129+02:00
54
+ parameters:
55
+ id: 1124861888666195714
56
+ name: Capacitor_33uF_6.3V
57
+ description: MLCC-Capacitor with R_leak & R_series and planned DC-Bias-Effect,
58
+ R_leak = 2963.636 Ohm
59
+ comment: null
60
+ created: 2025-09-11 19:47:04.399112
61
+ updated_last: 2025-09-11 19:47:04.399113
62
+ owner: NES Lab
63
+ group: NES Lab
64
+ visible2group: true
65
+ visible2all: true
66
+ SoC_init: 0.8
67
+ q_As: 0.00020789999999999996
68
+ p_VOC:
69
+ - 0.0
70
+ - 0.0
71
+ - 0.0
72
+ - 6.3
73
+ - 0.0
74
+ - 0.0
75
+ p_Rs:
76
+ - 0.0
77
+ - 0.0
78
+ - 0.0
79
+ - 0.0
80
+ - 0.0
81
+ - 0.0
82
+ p_RtS:
83
+ - 0.0
84
+ - 0.0
85
+ - 0.0
86
+ p_CtS:
87
+ - 0.0
88
+ - 0.0
89
+ - 0.0
90
+ p_RtL:
91
+ - 0.0
92
+ - 0.0
93
+ - 0.0
94
+ p_CtL:
95
+ - 0.0
96
+ - 0.0
97
+ - 0.0
98
+ p_rce: 1.0
99
+ kdash: 2.2250738585072014e-308
100
+ R_leak_Ohm: 2963636.3636363638
101
+ - datatype: VirtualStorageConfig
102
+ comment: created by script 'virtual_storage_fixture_creator.py'
103
+ created: 2025-09-11 19:47:04.433168+02:00
104
+ parameters:
105
+ id: 660779979738076740
106
+ name: Capacitor_47uF_6.3V
107
+ description: MLCC-Capacitor with R_leak & R_series and planned DC-Bias-Effect,
108
+ R_leak = 2080.851 Ohm
109
+ comment: null
110
+ created: 2025-09-11 19:47:04.399155
111
+ updated_last: 2025-09-11 19:47:04.399156
112
+ owner: NES Lab
113
+ group: NES Lab
114
+ visible2group: true
115
+ visible2all: true
116
+ SoC_init: 0.8
117
+ q_As: 0.0002961
118
+ p_VOC:
119
+ - 0.0
120
+ - 0.0
121
+ - 0.0
122
+ - 6.3
123
+ - 0.0
124
+ - 0.0
125
+ p_Rs:
126
+ - 0.0
127
+ - 0.0
128
+ - 0.0
129
+ - 0.0
130
+ - 0.0
131
+ - 0.0
132
+ p_RtS:
133
+ - 0.0
134
+ - 0.0
135
+ - 0.0
136
+ p_CtS:
137
+ - 0.0
138
+ - 0.0
139
+ - 0.0
140
+ p_RtL:
141
+ - 0.0
142
+ - 0.0
143
+ - 0.0
144
+ p_CtL:
145
+ - 0.0
146
+ - 0.0
147
+ - 0.0
148
+ p_rce: 1.0
149
+ kdash: 2.2250738585072014e-308
150
+ R_leak_Ohm: 2080851.0638297873
151
+ - datatype: VirtualStorageConfig
152
+ comment: created by script 'virtual_storage_fixture_creator.py'
153
+ created: 2025-09-11 19:47:04.433200+02:00
154
+ parameters:
155
+ id: 51678003530735820
156
+ name: Capacitor_100uF_6.3V
157
+ description: MLCC-Capacitor with R_leak & R_series and planned DC-Bias-Effect,
158
+ R_leak = 978.000 Ohm
159
+ comment: null
160
+ created: 2025-09-11 19:47:04.399199
161
+ updated_last: 2025-09-11 19:47:04.399200
162
+ owner: NES Lab
163
+ group: NES Lab
164
+ visible2group: true
165
+ visible2all: true
166
+ SoC_init: 0.8
167
+ q_As: 0.0006299999999999999
168
+ p_VOC:
169
+ - 0.0
170
+ - 0.0
171
+ - 0.0
172
+ - 6.3
173
+ - 0.0
174
+ - 0.0
175
+ p_Rs:
176
+ - 0.0
177
+ - 0.0
178
+ - 0.0
179
+ - 0.0
180
+ - 0.0
181
+ - 0.0
182
+ p_RtS:
183
+ - 0.0
184
+ - 0.0
185
+ - 0.0
186
+ p_CtS:
187
+ - 0.0
188
+ - 0.0
189
+ - 0.0
190
+ p_RtL:
191
+ - 0.0
192
+ - 0.0
193
+ - 0.0
194
+ p_CtL:
195
+ - 0.0
196
+ - 0.0
197
+ - 0.0
198
+ p_rce: 1.0
199
+ kdash: 2.2250738585072014e-308
200
+ R_leak_Ohm: 978000.0
shepherd_core/data_models/content/virtual_storage_fixture_param_experiments.py ADDED
@@ -0,0 +1,151 @@
1
+ """Script to determine proper parameters for the fixtures.
2
+
3
+ This is done by comparing data from datasheets or online sources
4
+ with the resulting behavior of the model.
5
+ """
6
+
7
+ from datetime import timedelta
8
+
9
+ from virtual_storage_config import VirtualStorageConfig
10
+
11
+ from shepherd_core import log
12
+ from shepherd_core.vsource.virtual_storage_models_kibam import ModelKiBaMPlus
13
+ from shepherd_core.vsource.virtual_storage_simulator import StorageSimulator
14
+
15
+
16
+ def experiment_self_discharge_lead_acid() -> None:
17
+ """Determine leakage resistor and plot behavior.
18
+
19
+ Datasheet of LEOCH LP12-1.2AH expects 3 to 20 % discharge/month
20
+ -> chosen 5 % for the fixtures
21
+ """
22
+ dt_s = 10
23
+ SoC_init = 1.0
24
+ SoC_final = 0.95
25
+ duration = timedelta(weeks=4)
26
+ R_leak1 = VirtualStorageConfig.lead_acid(q_mAh=1).calc_R_leak_battery(
27
+ duration, SoC_0=SoC_init, SoC_final=SoC_final
28
+ )
29
+ R_leak2 = (
30
+ VirtualStorageConfig.lead_acid(q_mAh=10).calc_R_leak_battery(
31
+ duration, SoC_0=SoC_init, SoC_final=SoC_final
32
+ )
33
+ * 10
34
+ )
35
+ log.info("R_leak_lead \t= %.0f Ohm [@1mAh]", R_leak1)
36
+ if round(R_leak1) != round(R_leak2):
37
+ raise ValueError("Values should match")
38
+ cfg1 = VirtualStorageConfig.lead_acid(q_mAh=1200)
39
+ sim = StorageSimulator(
40
+ models=[ModelKiBaMPlus(SoC_init=SoC_init, cfg=cfg1, dt_s=dt_s)],
41
+ dt_s=dt_s,
42
+ )
43
+
44
+ def step(_t: float, _s: float, _v: float) -> float:
45
+ return 0
46
+
47
+ sim.run(fn=step, duration_s=duration.total_seconds())
48
+ sim.plot(
49
+ f"XP {cfg1.name}, self-discharge, "
50
+ f"SoC {SoC_init:.3f} to {SoC_final:.3f} in {duration.total_seconds()} s"
51
+ )
52
+
53
+
54
+ def experiment_self_discharge_lipo() -> None:
55
+ """Determine leakage resistor and plot behavior.
56
+
57
+ According to wikipedia a typical Lipo looses 5 % in 4 weeks.
58
+ """
59
+ dt_s = 10
60
+ SoC_init = 1.0
61
+ SoC_final = 0.95
62
+ duration = timedelta(weeks=4)
63
+ R_leak1 = VirtualStorageConfig.lipo(q_mAh=1).calc_R_leak_battery(
64
+ duration, SoC_0=SoC_init, SoC_final=SoC_final
65
+ )
66
+ R_leak2 = (
67
+ VirtualStorageConfig.lipo(q_mAh=10).calc_R_leak_battery(
68
+ duration, SoC_0=SoC_init, SoC_final=SoC_final
69
+ )
70
+ * 10
71
+ )
72
+ log.info("R_leak_lipo \t= %.0f Ohm [@1mAh]", R_leak1)
73
+ if round(R_leak1) != round(R_leak2):
74
+ raise ValueError("Values should match")
75
+ cfg1 = VirtualStorageConfig.lipo(q_mAh=860)
76
+ sim = StorageSimulator(
77
+ models=[ModelKiBaMPlus(SoC_init=SoC_init, cfg=cfg1, dt_s=dt_s)],
78
+ dt_s=dt_s,
79
+ )
80
+
81
+ def step(_t: float, _s: float, _v: float) -> float:
82
+ return 0
83
+
84
+ sim.run(fn=step, duration_s=duration.total_seconds())
85
+ sim.plot(
86
+ f"XP {cfg1.name}, self-discharge, "
87
+ f"SoC {SoC_init:.3f} to {SoC_final:.3f} in {duration.total_seconds()} s"
88
+ )
89
+
90
+
91
+ def experiment_self_discharge_tantal_avx() -> None:
92
+ """Discharge Experiment: measured 5V to 3V decrease in 100 s.
93
+
94
+ https://github.com/orgua/bq_characteristics/tree/main/eval_kit_behavior_var1#capacitor
95
+ Note: first approach should be correct, but the second matches the plot
96
+ """
97
+ dt_s = 0.1
98
+ cfg0 = VirtualStorageConfig.capacitor(C_uF=100, V_rated=6.3)
99
+ duration = timedelta(seconds=100)
100
+ R_leak = cfg0.calc_R_leak_battery(duration, SoC_final=3.0 / 5.0)
101
+ log.info("R_leak_tantal \t= %.0f Ohm [@1uF]", R_leak * 100)
102
+ cfg1 = VirtualStorageConfig.capacitor(
103
+ C_uF=100, V_rated=6.3, R_leak_Ohm=R_leak, name="AVX TAJB107M006RNJ"
104
+ )
105
+ SoC_init = cfg1.approximate_SoC(V_OC=5.0)
106
+ sim = StorageSimulator(
107
+ models=[ModelKiBaMPlus(SoC_init=SoC_init, cfg=cfg1, dt_s=dt_s)],
108
+ dt_s=dt_s,
109
+ )
110
+
111
+ def step(_t: float, _s: float, _v: float) -> float:
112
+ return 0
113
+
114
+ sim.run(fn=step, duration_s=duration.total_seconds())
115
+ sim.plot(f"XP Tantal AVX, self-discharge {duration.total_seconds()} s")
116
+
117
+
118
+ def experiment_self_discharge_mlcc_tayo() -> None:
119
+ """Discharge Experiment: measured 5V to 1.8V decrease in 100 s.
120
+
121
+ Taiyo Yuden, JMK316ABJ107ML
122
+ https://github.com/orgua/bq_characteristics/tree/main/eval_kit_behavior_var1#capacitor
123
+ """
124
+ dt_s = 0.1
125
+ duration = timedelta(seconds=100)
126
+ cfg0 = VirtualStorageConfig.capacitor(C_uF=74, V_rated=6.3)
127
+ R_leak = cfg0.calc_R_leak_battery(duration, SoC_final=1.8 / 5.0)
128
+ log.info("R_leak_mlcc \t= %.0f Ohm [@1uF]", R_leak * 74)
129
+ R_leak = cfg0.calc_R_leak_capacitor(duration, SoC_final=1.8 / 5.0)
130
+ log.info("R_leak_mlcc \t= %.0f Ohm [@1uF]", R_leak * 74)
131
+ cfg1 = VirtualStorageConfig.capacitor(
132
+ C_uF=74, V_rated=6.3, R_leak_Ohm=R_leak, name="Taiyo JMK316ABJ107ML"
133
+ )
134
+ SoC_init = cfg1.approximate_SoC(V_OC=5.0)
135
+ sim = StorageSimulator(
136
+ models=[ModelKiBaMPlus(SoC_init=SoC_init, cfg=cfg1, dt_s=dt_s)],
137
+ dt_s=dt_s,
138
+ )
139
+
140
+ def step(_t: float, _s: float, _v: float) -> float:
141
+ return 0
142
+
143
+ sim.run(fn=step, duration_s=duration.total_seconds())
144
+ sim.plot(f"XP MLCC Tayo, self-discharge {duration.total_seconds()} s")
145
+
146
+
147
+ if __name__ == "__main__":
148
+ experiment_self_discharge_lead_acid()
149
+ experiment_self_discharge_lipo()
150
+ experiment_self_discharge_tantal_avx()
151
+ experiment_self_discharge_mlcc_tayo()
shepherd_core/data_models/content/virtual_storage_fixture_super.yaml ADDED
@@ -0,0 +1,150 @@
1
+ - datatype: VirtualStorageConfig
2
+ comment: created by script 'virtual_storage_fixture_creator.py'
3
+ created: 2025-09-11 19:47:04.438729+02:00
4
+ parameters:
5
+ id: 331843882344025539
6
+ name: Maxwell BCAP0025 P300 X11
7
+ description: SuperCapacitor with typically 1000 hours / 500 k cycles (not modeled),
8
+ R_leak = 54.545 Ohm, R_serial = 0 Ohm
9
+ comment: null
10
+ created: 2025-09-11 19:47:04.399243
11
+ updated_last: 2025-09-11 19:47:04.399244
12
+ owner: NES Lab
13
+ group: NES Lab
14
+ visible2group: true
15
+ visible2all: true
16
+ SoC_init: 0.8
17
+ q_As: 75.0
18
+ p_VOC:
19
+ - 0.0
20
+ - 0.0
21
+ - 0.0
22
+ - 3.0
23
+ - 0.0
24
+ - 0.0
25
+ p_Rs:
26
+ - 0.0
27
+ - 0.0
28
+ - 0.017
29
+ - 0.0
30
+ - 0.0
31
+ - 0.0
32
+ p_RtS:
33
+ - 0.0
34
+ - 0.0
35
+ - 0.0
36
+ p_CtS:
37
+ - 0.0
38
+ - 0.0
39
+ - 0.0
40
+ p_RtL:
41
+ - 0.0
42
+ - 0.0
43
+ - 0.0
44
+ p_CtL:
45
+ - 0.0
46
+ - 0.0
47
+ - 0.0
48
+ p_rce: 1.0
49
+ kdash: 2.2250738585072014e-308
50
+ R_leak_Ohm: 54545.454545454544
51
+ - datatype: VirtualStorageConfig
52
+ comment: created by script 'virtual_storage_fixture_creator.py'
53
+ created: 2025-09-11 19:47:04.438772+02:00
54
+ parameters:
55
+ id: 1065295619710061461
56
+ name: Abracon ADCM-S06R0SA126RB
57
+ description: SuperCapacitor with typically 1000 hours / 500 k cycles (not modeled),
58
+ R_leak = 75.000 Ohm, R_serial = 0 Ohm
59
+ comment: null
60
+ created: 2025-09-11 19:47:04.399283
61
+ updated_last: 2025-09-11 19:47:04.399284
62
+ owner: NES Lab
63
+ group: NES Lab
64
+ visible2group: true
65
+ visible2all: true
66
+ SoC_init: 0.8
67
+ q_As: 72.0
68
+ p_VOC:
69
+ - 0.0
70
+ - 0.0
71
+ - 0.0
72
+ - 6.0
73
+ - 0.0
74
+ - 0.0
75
+ p_Rs:
76
+ - 0.0
77
+ - 0.0
78
+ - 0.09
79
+ - 0.0
80
+ - 0.0
81
+ - 0.0
82
+ p_RtS:
83
+ - 0.0
84
+ - 0.0
85
+ - 0.0
86
+ p_CtS:
87
+ - 0.0
88
+ - 0.0
89
+ - 0.0
90
+ p_RtL:
91
+ - 0.0
92
+ - 0.0
93
+ - 0.0
94
+ p_CtL:
95
+ - 0.0
96
+ - 0.0
97
+ - 0.0
98
+ p_rce: 1.0
99
+ kdash: 2.2250738585072014e-308
100
+ R_leak_Ohm: 75000.0
101
+ - datatype: VirtualStorageConfig
102
+ comment: created by script 'virtual_storage_fixture_creator.py'
103
+ created: 2025-09-11 19:47:04.438806+02:00
104
+ parameters:
105
+ id: 1130328829082407568
106
+ name: AVX SCMT32F755SRBA0
107
+ description: SuperCapacitor with typically 1000 hours / 500 k cycles (not modeled),
108
+ R_leak = 76.923 Ohm, R_serial = 0 Ohm
109
+ comment: null
110
+ created: 2025-09-11 19:47:04.399324
111
+ updated_last: 2025-09-11 19:47:04.399324
112
+ owner: NES Lab
113
+ group: NES Lab
114
+ visible2group: true
115
+ visible2all: true
116
+ SoC_init: 0.8
117
+ q_As: 41.25
118
+ p_VOC:
119
+ - 0.0
120
+ - 0.0
121
+ - 0.0
122
+ - 5.5
123
+ - 0.0
124
+ - 0.0
125
+ p_Rs:
126
+ - 0.0
127
+ - 0.0
128
+ - 0.09
129
+ - 0.0
130
+ - 0.0
131
+ - 0.0
132
+ p_RtS:
133
+ - 0.0
134
+ - 0.0
135
+ - 0.0
136
+ p_CtS:
137
+ - 0.0
138
+ - 0.0
139
+ - 0.0
140
+ p_RtL:
141
+ - 0.0
142
+ - 0.0
143
+ - 0.0
144
+ p_CtL:
145
+ - 0.0
146
+ - 0.0
147
+ - 0.0
148
+ p_rce: 1.0
149
+ kdash: 2.2250738585072014e-308
150
+ R_leak_Ohm: 76923.07692307692