zhinst-core 24.10.65175__cp312-cp312-manylinux2014_aarch64.whl → 25.4.0.628__cp312-cp312-manylinux2014_aarch64.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.

Potentially problematic release.


This version of zhinst-core might be problematic. Click here for more details.

zhinst/core/__init__.pyi CHANGED
@@ -21,7 +21,7 @@ __version__: str
21
21
  LabOneResultAny: TypeAlias = Any
22
22
  LabOneResultNested: TypeAlias = Dict[str, Union[LabOneResultNested, LabOneResultAny]]
23
23
 
24
- _STUB_VERSION_HASH = "242eef0a8d40246fa70079ecc1971262"
24
+ _STUB_VERSION_HASH = "e6a61a2faeb03c66bf166f3b93444f9c"
25
25
 
26
26
  class ziListEnum(Enum):
27
27
  """Enumeration for listNodes."""
@@ -52,20 +52,24 @@ class ziListEnum(Enum):
52
52
  class ModuleBase:
53
53
  def clear(self) -> None:
54
54
  """End the module thread."""
55
+
55
56
  def execute(self) -> None:
56
57
  """Start the module execution.
57
58
 
58
59
  Subscribing or unsubscribing is not possible until the execution is
59
60
  finished."""
61
+
60
62
  def finish(self) -> None:
61
63
  """Stop the execution.
62
64
 
63
65
  The execution may be restarted by calling 'execute' again."""
66
+
64
67
  def finished(self) -> bool:
65
68
  """Check if the execution has finished.
66
69
 
67
70
  Returns:
68
71
  Flag if the execution is finished."""
72
+
69
73
  @overload
70
74
  def get(self, path: str, *, flat: Literal[False] = False) -> LabOneResultNested:
71
75
  """Return a dict with all nodes from the specified sub-tree.
@@ -78,6 +82,7 @@ class ModuleBase:
78
82
 
79
83
  Returns:
80
84
  A dict with all nodes from the specified sub-tree."""
85
+
81
86
  @overload
82
87
  def get(self, path: str, *, flat: Literal[True]) -> Dict[str, LabOneResultAny]:
83
88
  """Return a dict with all nodes from the specified sub-tree.
@@ -90,6 +95,7 @@ class ModuleBase:
90
95
 
91
96
  Returns:
92
97
  A dict with all nodes from the specified sub-tree."""
98
+
93
99
  def get(self, path: str, *, flat: bool = False) -> LabOneResultNested:
94
100
  """Return a dict with all nodes from the specified sub-tree.
95
101
 
@@ -101,6 +107,7 @@ class ModuleBase:
101
107
 
102
108
  Returns:
103
109
  A dict with all nodes from the specified sub-tree."""
110
+
104
111
  def getDouble(self, path: str) -> float:
105
112
  """Get a double value from the specified node.
106
113
 
@@ -109,6 +116,7 @@ class ModuleBase:
109
116
 
110
117
  Returns:
111
118
  Floating point double value."""
119
+
112
120
  def getInt(self, path: str) -> int:
113
121
  """Get a integer value from the specified node.
114
122
 
@@ -117,6 +125,7 @@ class ModuleBase:
117
125
 
118
126
  Returns:
119
127
  Integer value."""
128
+
120
129
  def getString(self, path: str) -> str: # Wrong return type in docs (object)
121
130
  """Get a string value from the specified node.
122
131
 
@@ -125,6 +134,7 @@ class ModuleBase:
125
134
 
126
135
  Returns:
127
136
  String value."""
137
+
128
138
  def getStringUnicode(self, path: str) -> str: # Wrong return type in docs (object)
129
139
  """Get a unicode encoded string value from the specified node.
130
140
 
@@ -134,6 +144,7 @@ class ModuleBase:
134
144
 
135
145
  Returns:
136
146
  Unicode encoded string value."""
147
+
137
148
  def help(self, path: str = "*") -> None:
138
149
  """Prints a well-formatted description of a module parameter.
139
150
 
@@ -141,6 +152,7 @@ class ModuleBase:
141
152
  path: Path for which the nodes should be listed. The path may
142
153
  contain wildcards so that the returned nodes do not
143
154
  necessarily have to have the same parents."""
155
+
144
156
  def listNodes(
145
157
  self,
146
158
  path: str,
@@ -182,6 +194,7 @@ class ModuleBase:
182
194
 
183
195
  Returns:
184
196
  List of node names."""
197
+
185
198
  def listNodesJSON(
186
199
  self,
187
200
  path: str,
@@ -220,11 +233,13 @@ class ModuleBase:
220
233
 
221
234
  Returns:
222
235
  JSON dictionary nodepath:information"""
236
+
223
237
  def progress(self) -> np.ndarray:
224
238
  """Reports the progress of the execution.
225
239
 
226
240
  Returns:
227
241
  Progress with a number between 0 and 1."""
242
+
228
243
  @overload
229
244
  def read(self, flat: Literal[False]) -> LabOneResultNested:
230
245
  """Read the module output data.
@@ -240,6 +255,7 @@ class ModuleBase:
240
255
 
241
256
  Returns:
242
257
  The module output data."""
258
+
243
259
  @overload
244
260
  def read(self, flat: Literal[True]) -> Dict[str, LabOneResultAny]:
245
261
  """Read the module output data.
@@ -255,6 +271,7 @@ class ModuleBase:
255
271
 
256
272
  Returns:
257
273
  The module output data."""
274
+
258
275
  def read(self, flat: bool = False) -> Dict[str, LabOneResultAny]:
259
276
  """Read the module output data.
260
277
 
@@ -269,11 +286,13 @@ class ModuleBase:
269
286
 
270
287
  Returns:
271
288
  The module output data."""
289
+
272
290
  def save(self, filename: str) -> None:
273
291
  """Save measured data to file.
274
292
 
275
293
  Args:
276
294
  filename: File name string (without extension)."""
295
+
277
296
  @overload
278
297
  def set(self, path: str, value: Any) -> None:
279
298
  """Set a single node value.
@@ -284,6 +303,7 @@ class ModuleBase:
284
303
  path: Node path string.
285
304
  value: The value to set in case of a single node set.
286
305
  """
306
+
287
307
  @overload
288
308
  def set(self, items: Union[List[Tuple[str, Any]], Tuple[Tuple[str, Any]]]) -> None:
289
309
  """Set multiple nodes. `items` is a list of path/value pairs.
@@ -293,6 +313,7 @@ class ModuleBase:
293
313
  Args:
294
314
  items: A list of path/value pairs.
295
315
  """
316
+
296
317
  def subscribe(self, path: Union[str, List[str]]) -> None:
297
318
  """Subscribe to one or several nodes.
298
319
 
@@ -304,8 +325,10 @@ class ModuleBase:
304
325
  path: Path string of the node. Use wild card to
305
326
  select all. Alternatively also a list of path
306
327
  strings can be specified."""
328
+
307
329
  def trigger(self) -> None:
308
330
  """Execute a manual trigger, if applicable."""
331
+
309
332
  def unsubscribe(self, path: Union[str, List[str]]) -> None:
310
333
  """Unsubscribe from one or several nodes.
311
334
 
@@ -336,10 +359,19 @@ class ziDAQServer:
336
359
  Args:
337
360
  host: Host string e.g. '127.0.0.1' for localhost
338
361
  port: Port number e.g. 8004 for the ziDataServer.
339
- api_level: API level number."""
362
+ api_level: API level number.
363
+ allow_version_mismatch: if set to True, the connection to the data-server
364
+ will succeed even if the data-server is on a different version of LabOne.
365
+ If False, an exception will be raised if the data-server is on a
366
+ different version. (default = False)
367
+ """
340
368
 
341
369
  def __init__(
342
- self, host: str, port: int, api_level: Literal[0, 1, 4, 5, 6]
370
+ self,
371
+ host: str,
372
+ port: int,
373
+ api_level: Literal[0, 1, 4, 5, 6],
374
+ allow_version_mismatch: bool = False,
343
375
  ) -> None: ...
344
376
  def asyncSetDouble(self, path: str, value: float) -> None:
345
377
  """Asynchronously set the value as double for a specified node.
@@ -348,11 +380,12 @@ class ziDAQServer:
348
380
  does not wait for the data server acknowledgement.
349
381
 
350
382
  Warning:
351
- This command does have no error reporting at all.
383
+ This command never reports any error.
352
384
 
353
385
  Args:
354
386
  path: Path string of the node.
355
387
  value: Value of the node."""
388
+
356
389
  def asyncSetInt(self, path: str, value: int) -> None:
357
390
  """Asynchronously set the value as integer for a specified node.
358
391
 
@@ -360,11 +393,12 @@ class ziDAQServer:
360
393
  does not wait for the data server acknowledgement.
361
394
 
362
395
  Warning:
363
- This command does have no error reporting at all.
396
+ This command never reports any error.
364
397
 
365
398
  Args:
366
399
  path: Path string of the node.
367
400
  value: Value of the node."""
401
+
368
402
  def asyncSetString(self, path: str, value: str) -> None:
369
403
  """Asynchronously set the value as string for a specified node.
370
404
 
@@ -372,11 +406,12 @@ class ziDAQServer:
372
406
  does not wait for the data server acknowledgement.
373
407
 
374
408
  Warning:
375
- This command does have no error reporting at all.
409
+ This command never reports any error.
376
410
 
377
411
  Args:
378
412
  path: Path string of the node.
379
413
  value: Value of the node."""
414
+
380
415
  def awgModule(self) -> AwgModule:
381
416
  """Create a AwgModule object.
382
417
 
@@ -384,6 +419,7 @@ class ziDAQServer:
384
419
 
385
420
  Returns:
386
421
  Created module instance."""
422
+
387
423
  def connect(self) -> None:
388
424
  """Initiate the connection to the data server.
389
425
 
@@ -392,6 +428,7 @@ class ziDAQServer:
392
428
  established. It is therefore not necessary to call this
393
429
  function unless one actively disconnects from the data
394
430
  server with the `disconnect` method."""
431
+
395
432
  def connectDevice(
396
433
  self,
397
434
  dev: str,
@@ -408,6 +445,7 @@ class ziDAQServer:
408
445
  dev: Device serial.
409
446
  interface: Device interface.
410
447
  params: Optional interface parameters string."""
448
+
411
449
  def dataAcquisitionModule(self) -> DataAcquisitionModule:
412
450
  """Create a DataAcquisitionModule object.
413
451
 
@@ -415,6 +453,7 @@ class ziDAQServer:
415
453
 
416
454
  Returns:
417
455
  Created module instance."""
456
+
418
457
  def deviceSettings(
419
458
  self,
420
459
  ) -> DeviceSettingsModule: # Deprecated arguments not included
@@ -424,6 +463,7 @@ class ziDAQServer:
424
463
 
425
464
  Returns:
426
465
  Created module instance."""
466
+
427
467
  def disconnect(self) -> None:
428
468
  """Disconnects from the data server.
429
469
 
@@ -431,6 +471,7 @@ class ziDAQServer:
431
471
  During the destruction the connection is closed properly.
432
472
  This function therefore does not need to be called in normal
433
473
  usage."""
474
+
434
475
  def disconnectDevice(self, dev: str) -> None:
435
476
  """Disconnect a device from the data server.
436
477
 
@@ -438,6 +479,7 @@ class ziDAQServer:
438
479
  the device may not yet be finished.
439
480
  Args:
440
481
  dev: Device serial string of device to disconnect."""
482
+
441
483
  def echoDevice(self, dev: str) -> None: # Deprecated
442
484
  """Deprecated, see the 'sync' command.
443
485
 
@@ -448,10 +490,12 @@ class ziDAQServer:
448
490
  a previous command.
449
491
  Args:
450
492
  dev: Device string e.g. 'dev100'."""
493
+
451
494
  def flush(self) -> None: # Deprecated
452
495
  """Deprecated, see the 'sync' command.
453
496
 
454
497
  The flush command is identical to the sync command."""
498
+
455
499
  @overload
456
500
  def get(
457
501
  self,
@@ -488,6 +532,7 @@ class ziDAQServer:
488
532
 
489
533
  Returns:
490
534
  A dict with all nodes from the specified sub-tree."""
535
+
491
536
  @overload
492
537
  def get(
493
538
  self,
@@ -528,6 +573,7 @@ class ziDAQServer:
528
573
 
529
574
  Returns:
530
575
  A dict with all nodes from the specified sub-tree."""
576
+
531
577
  def get(
532
578
  self,
533
579
  paths: str,
@@ -567,6 +613,7 @@ class ziDAQServer:
567
613
 
568
614
  Returns:
569
615
  A dict with all nodes from the specified sub-tree."""
616
+
570
617
  def getAsEvent(self, path: str) -> None:
571
618
  """Trigger an event on the specified node.
572
619
 
@@ -575,6 +622,7 @@ class ziDAQServer:
575
622
  Args:
576
623
  path: Path string of the node. Note: Wildcards and paths
577
624
  referring to streaming nodes are not permitted."""
625
+
578
626
  def asyncGetAsEvent(self, path: str) -> None:
579
627
  """Trigger an event on the specified node.
580
628
 
@@ -590,6 +638,7 @@ class ziDAQServer:
590
638
  Args:
591
639
  path: Path string of the node. Note: Wildcards and paths
592
640
  referring to streaming nodes are not permitted."""
641
+
593
642
  def getAuxInSample(self, path: str) -> Dict[str, np.ndarray]:
594
643
  """Returns a single auxin sample.
595
644
 
@@ -598,6 +647,7 @@ class ziDAQServer:
598
647
 
599
648
  Args:
600
649
  path: Path string of the node"""
650
+
601
651
  def getByte(self, path: str) -> str:
602
652
  """Get a byte array (string) value from the specified node.
603
653
 
@@ -606,6 +656,7 @@ class ziDAQServer:
606
656
 
607
657
  Returns:
608
658
  Byte array (string) value."""
659
+
609
660
  def getComplex(self, path: str) -> complex:
610
661
  """Get a complex double value from the specified node.
611
662
 
@@ -614,6 +665,7 @@ class ziDAQServer:
614
665
 
615
666
  Returns:
616
667
  Complex double value."""
668
+
617
669
  def getConnectionAPILevel(self) -> Literal[0, 1, 4, 5, 6]: # Deprecated
618
670
  """Returns ziAPI level used for the active connection.
619
671
 
@@ -621,6 +673,7 @@ class ziDAQServer:
621
673
 
622
674
  Returns:
623
675
  ziAPI level used for the active connection."""
676
+
624
677
  def getDIO(self, path: str) -> Dict[str, np.ndarray]:
625
678
  """Returns a single DIO sample.
626
679
 
@@ -629,6 +682,7 @@ class ziDAQServer:
629
682
 
630
683
  Returns:
631
684
  Single DIO sample."""
685
+
632
686
  def getDebugLogpath(self) -> str:
633
687
  """Path where logfiles are stored.
634
688
 
@@ -637,6 +691,7 @@ class ziDAQServer:
637
691
 
638
692
  Returns:
639
693
  Path to directory where logfiles are stored."""
694
+
640
695
  def getDouble(self, path: str) -> float:
641
696
  """Get a double value from the specified node.
642
697
 
@@ -645,6 +700,7 @@ class ziDAQServer:
645
700
 
646
701
  Returns:
647
702
  Floating point double value."""
703
+
648
704
  def getInt(self, path: str) -> int:
649
705
  """Get a integer value from the specified node.
650
706
 
@@ -653,6 +709,7 @@ class ziDAQServer:
653
709
 
654
710
  Returns:
655
711
  Integer value."""
712
+
656
713
  def getList(self, path: str, flags: int = 8) -> List[str]: # Deprecated
657
714
  """DEPRECATED: superseded by get(...).
658
715
 
@@ -664,6 +721,7 @@ class ziDAQServer:
664
721
  result. Allowed:
665
722
  ZI_LIST_NODES_SETTINGSONLY = 0x08 (default)
666
723
  ZI_LIST_NODES_ALL = 0x00 (all nodes)"""
724
+
667
725
  def getSample(self, path: str) -> Dict[str, np.ndarray]:
668
726
  """Returns a single demodulator sample (including DIO and AuxIn).
669
727
 
@@ -674,6 +732,7 @@ class ziDAQServer:
674
732
 
675
733
  Returns:
676
734
  Single demodulator sample (including DIO and AuxIn)."""
735
+
677
736
  def getString(self, path: str) -> str: # `object` in documentation
678
737
  """Get a string value from the specified node.
679
738
 
@@ -682,6 +741,7 @@ class ziDAQServer:
682
741
 
683
742
  Returns:
684
743
  String value."""
744
+
685
745
  def getStringUnicode(self, path: str) -> str: # `object` in documentation
686
746
  """Get a unicode encoded string value from the specified node.
687
747
 
@@ -691,6 +751,7 @@ class ziDAQServer:
691
751
 
692
752
  Returns:
693
753
  Unicode encoded string value."""
754
+
694
755
  def help(self, path: str) -> None:
695
756
  """Prints a well-formatted description of a node.
696
757
 
@@ -700,6 +761,7 @@ class ziDAQServer:
700
761
  path: Path for which the nodes should be listed. The path may
701
762
  contain wildcards so that the returned nodes do not
702
763
  necessarily have to have the same parents."""
764
+
703
765
  def impedanceModule(self) -> ImpedanceModule:
704
766
  """Create a ImpedanceModule object.
705
767
 
@@ -707,6 +769,7 @@ class ziDAQServer:
707
769
 
708
770
  Returns:
709
771
  Created module instance."""
772
+
710
773
  def listNodes(
711
774
  self,
712
775
  path: str,
@@ -749,6 +812,7 @@ class ziDAQServer:
749
812
 
750
813
  Returns:
751
814
  List of node names."""
815
+
752
816
  def listNodesJSON(
753
817
  self,
754
818
  path: str,
@@ -790,8 +854,10 @@ class ziDAQServer:
790
854
 
791
855
  Returns:
792
856
  JSON dictionary nodepath:information"""
857
+
793
858
  def logOff(self) -> None:
794
859
  """Disables logging of commands sent to a server."""
860
+
795
861
  def logOn(self, flags: int, filename: str, style: Literal[0, 1, 2] = 2) -> None:
796
862
  """Enables logging of commands sent to a server.
797
863
 
@@ -824,6 +890,7 @@ class ziDAQServer:
824
890
  filename: Log file name.
825
891
  style: Log style (LOG_STYLE_TELNET: 0, LOG_STYLE_MATLAB: 1,
826
892
  LOG_STYLE_PYTHON: 2 (default))."""
893
+
827
894
  def multiDeviceSyncModule(self) -> MultiDeviceSyncModule:
828
895
  """Create a MultiDeviceSyncModule object.
829
896
 
@@ -831,6 +898,7 @@ class ziDAQServer:
831
898
 
832
899
  Returns:
833
900
  Created module instance."""
901
+
834
902
  def pidAdvisor(self) -> PidAdvisorModule: # Deprecated arguments not included
835
903
  """Create a PID Advisor Module object.
836
904
 
@@ -838,6 +906,7 @@ class ziDAQServer:
838
906
 
839
907
  Returns:
840
908
  Created module instance."""
909
+
841
910
  @overload
842
911
  def poll(
843
912
  self,
@@ -880,6 +949,7 @@ class ziDAQServer:
880
949
  Returns:
881
950
  A dict with the polled events. (Empty if no event
882
951
  occurred within the given timeout)"""
952
+
883
953
  @overload
884
954
  def poll(
885
955
  self,
@@ -922,6 +992,7 @@ class ziDAQServer:
922
992
  Returns:
923
993
  A dict with the polled events. (Empty if no event
924
994
  occurred within the given timeout)"""
995
+
925
996
  def poll(
926
997
  self,
927
998
  recording_time_s: float,
@@ -962,6 +1033,7 @@ class ziDAQServer:
962
1033
  Returns:
963
1034
  A dict with the polled events. (Empty if no event occurred within
964
1035
  the given timeout)"""
1036
+
965
1037
  def pollEvent(self, timeout_ms: int) -> Dict[str, LabOneResultAny]:
966
1038
  """Poll a single Event.
967
1039
 
@@ -979,6 +1051,7 @@ class ziDAQServer:
979
1051
  Returns:
980
1052
  A dict with the polled event. (Empty if no event
981
1053
  occurred within the given timeout)"""
1054
+
982
1055
  def precompensationAdvisor(self) -> PrecompensationAdvisorModule:
983
1056
  """Create a PrecompensationAdvisorModule object.
984
1057
 
@@ -986,6 +1059,7 @@ class ziDAQServer:
986
1059
 
987
1060
  Returns:
988
1061
  Created module instance."""
1062
+
989
1063
  def programRT(self, dev: str, filename: str) -> None:
990
1064
  """Program RT.
991
1065
  Only relevant for a HF2 device.
@@ -993,6 +1067,7 @@ class ziDAQServer:
993
1067
  Args:
994
1068
  dev: Device identifier e.g. 'dev99'.
995
1069
  filename: File name of the RT program."""
1070
+
996
1071
  def quantumAnalyzerModule(self) -> QuantumAnalyzerModule:
997
1072
  """Create a QuantumAnalyzerModule object.
998
1073
 
@@ -1000,6 +1075,7 @@ class ziDAQServer:
1000
1075
 
1001
1076
  Returns:
1002
1077
  Created module instance."""
1078
+
1003
1079
  def record(self) -> RecorderModule: ... # Deprecated arguments not included
1004
1080
 
1005
1081
  """Create a Record Module object.
@@ -1014,6 +1090,7 @@ class ziDAQServer:
1014
1090
 
1015
1091
  Returns:
1016
1092
  Revision number."""
1093
+
1017
1094
  def scopeModule(self) -> ScopeModule:
1018
1095
  """Create a ScopeModule object.
1019
1096
 
@@ -1021,6 +1098,7 @@ class ziDAQServer:
1021
1098
 
1022
1099
  Returns:
1023
1100
  Created module instance."""
1101
+
1024
1102
  @overload
1025
1103
  def set(self, path: str, value: Any) -> None:
1026
1104
  """Overloaded function.
@@ -1033,6 +1111,7 @@ class ziDAQServer:
1033
1111
  value: The value to set in case of a single node set
1034
1112
  (items is the node path).
1035
1113
  """
1114
+
1036
1115
  @overload
1037
1116
  def set(self, items: Union[List[Tuple[str, Any]], Tuple[Tuple[str, Any]]]) -> None:
1038
1117
  """Set multiple nodes. `items` is a list of path/value pairs.
@@ -1042,6 +1121,7 @@ class ziDAQServer:
1042
1121
  Args:
1043
1122
  items: A list of path/value pairs
1044
1123
  """
1124
+
1045
1125
  def set(
1046
1126
  self,
1047
1127
  items_or_path: Union[Union[List[Tuple[str, Any]], Tuple[Tuple[str, Any]]], str],
@@ -1065,6 +1145,7 @@ class ziDAQServer:
1065
1145
  value: The value to set in case of a single node set
1066
1146
  (items is the node path).
1067
1147
  """
1148
+
1068
1149
  def setByte(self, path: str, value: Any) -> None:
1069
1150
  """Set the value as byte array (string) for a specified node.
1070
1151
 
@@ -1074,6 +1155,7 @@ class ziDAQServer:
1074
1155
  Args:
1075
1156
  path: Path string of the node.
1076
1157
  value: Value of the node."""
1158
+
1077
1159
  def setComplex(self, path: str, value: complex) -> None:
1078
1160
  """Set the value as complex double for a specified node.
1079
1161
 
@@ -1083,6 +1165,7 @@ class ziDAQServer:
1083
1165
  Args:
1084
1166
  path: Path string of the node.
1085
1167
  value: Value of the node."""
1168
+
1086
1169
  def setDebugLevel(self, severity: Literal[0, 1, 2, 3, 4, 5, 6]) -> None:
1087
1170
  """Enables debug log and sets the debug level.
1088
1171
 
@@ -1091,16 +1174,19 @@ class ziDAQServer:
1091
1174
  Args:
1092
1175
  severity: Debug level (trace:0, debug:1, info:2, status:3,
1093
1176
  warning:4, error:5, fatal:6)."""
1177
+
1094
1178
  def setDebugLevelConsole(self, severity: Literal[0, 1, 2, 3, 4, 5, 6]) -> None:
1095
1179
  """Enables debug log and sets the debug level for the console output.
1096
1180
  Args:
1097
1181
  severity: Debug level (trace:0, debug:1, info:2, status:3,
1098
1182
  warning:4, error:5, fatal:6)."""
1183
+
1099
1184
  def setDebugLevelFile(self, severity: Literal[0, 1, 2, 3, 4, 5, 6]) -> None:
1100
1185
  """Enables debug log and sets the debug level for the file output.
1101
1186
  Args:
1102
1187
  severity: Debug level (trace:0, debug:1, info:2, status:3,
1103
1188
  warning:4, error:5, fatal:6)."""
1189
+
1104
1190
  def setDebugLogpath(self, path: str) -> None:
1105
1191
  """Sets the path where logfiles are stored.
1106
1192
 
@@ -1109,6 +1195,7 @@ class ziDAQServer:
1109
1195
 
1110
1196
  Args:
1111
1197
  path: Path to directory where logfiles are stored."""
1198
+
1112
1199
  def setDeprecated(
1113
1200
  self, items: Union[List[Tuple[str, Any]], Tuple[Tuple[str, Any]]]
1114
1201
  ) -> None:
@@ -1118,6 +1205,7 @@ class ziDAQServer:
1118
1205
 
1119
1206
  Args:
1120
1207
  items: A list of path/value pairs."""
1208
+
1121
1209
  def setDouble(self, path: str, value: float) -> None:
1122
1210
  """Set the value as double for a specified node.
1123
1211
 
@@ -1127,6 +1215,7 @@ class ziDAQServer:
1127
1215
  Args:
1128
1216
  path: Path string of the node.
1129
1217
  value: Value of the node."""
1218
+
1130
1219
  def setInt(self, path: str, value: int) -> None:
1131
1220
  """Set the value as integer for a specified node.
1132
1221
 
@@ -1136,6 +1225,7 @@ class ziDAQServer:
1136
1225
  Args:
1137
1226
  path: Path string of the node.
1138
1227
  value: Value of the node."""
1228
+
1139
1229
  def setString(self, path: str, value: str) -> None:
1140
1230
  """Set the value as string for a specified node.
1141
1231
 
@@ -1145,6 +1235,7 @@ class ziDAQServer:
1145
1235
  Args:
1146
1236
  path: Path string of the node.
1147
1237
  value: Value of the node."""
1238
+
1148
1239
  def setVector(
1149
1240
  self,
1150
1241
  path: str,
@@ -1165,6 +1256,7 @@ class ziDAQServer:
1165
1256
  path: Path string of the node.
1166
1257
  value: Vector ((u)int8, (u)int16, (u)int32, (u)int64, float, double)
1167
1258
  or string to write."""
1259
+
1168
1260
  def subscribe(self, path: Union[str, List[str]]) -> None:
1169
1261
  """Subscribe to one or several nodes.
1170
1262
 
@@ -1176,6 +1268,7 @@ class ziDAQServer:
1176
1268
  path: Path string of the node. Use wild card to
1177
1269
  select all. Alternatively also a list of path
1178
1270
  strings can be specified."""
1271
+
1179
1272
  def sweep(self) -> SweeperModule: # Deprecated arguments not included
1180
1273
  """Create a Sweeper Module object.
1181
1274
 
@@ -1183,6 +1276,7 @@ class ziDAQServer:
1183
1276
 
1184
1277
  Returns:
1185
1278
  Created module instance."""
1279
+
1186
1280
  def sync(self) -> None:
1187
1281
  """Synchronize all data paths.
1188
1282
  Ensures that get and poll commands return data which
@@ -1193,54 +1287,46 @@ class ziDAQServer:
1193
1287
  Warning:
1194
1288
  This blocks until all devices connected to the data
1195
1289
  server report a ready state! This can take up to a minute."""
1290
+
1196
1291
  def syncSetDouble(self, path: str, value: float) -> float:
1197
1292
  """Synchronously set the value as double for a specified node.
1198
1293
 
1199
1294
  Synchronously means that the command is blocking until
1200
1295
  the device has acknowledged the set request.
1201
1296
 
1202
- Warning:
1203
- This command takes significantly longer than a non sync
1204
- command and should be used with care.
1205
-
1206
1297
  Args:
1207
1298
  path: Path string of the node.
1208
1299
  value: Value of the node.
1209
1300
 
1210
1301
  Returns:
1211
1302
  Acknowledged value by the device."""
1303
+
1212
1304
  def syncSetInt(self, path: str, value: int) -> int:
1213
1305
  """Synchronously set the value as integer for a specified node.
1214
1306
 
1215
1307
  Synchronously means that the command is blocking until
1216
1308
  the device has acknowledged the set request.
1217
1309
 
1218
- Warning:
1219
- This command takes significantly longer than a non sync
1220
- command and should be used with care.
1221
-
1222
1310
  Args:
1223
1311
  path: Path string of the node.
1224
1312
  value: Value of the node.
1225
1313
 
1226
1314
  Returns:
1227
1315
  Acknowledged value by the device."""
1316
+
1228
1317
  def syncSetString(self, path: str, value: str) -> str:
1229
1318
  """Synchronously set the value as string for a specified node.
1230
1319
 
1231
1320
  Synchronously means that the command is blocking until
1232
1321
  the device has acknowledged the set request.
1233
1322
 
1234
- Warning:
1235
- This command takes significantly longer than a non sync
1236
- command and should be used with care.
1237
-
1238
1323
  Args:
1239
1324
  path: Path string of the node.
1240
1325
  value: Value of the node.
1241
1326
 
1242
1327
  Returns:
1243
1328
  Acknowledged value by the device."""
1329
+
1244
1330
  def unsubscribe(self, path: Union[str, List[str]]) -> None:
1245
1331
  """Unsubscribe data streams.
1246
1332
 
@@ -1251,14 +1337,17 @@ class ziDAQServer:
1251
1337
  path: Path string of the node. Use wild card to
1252
1338
  select all. Alternatively also a list of path
1253
1339
  strings can be specified."""
1340
+
1254
1341
  def update(self) -> None:
1255
1342
  """Check if additional devices are attached.
1256
1343
 
1257
1344
  Only revelant for connections to an HF2 Data Server.
1258
1345
  This function is not needed for servers running under windows
1259
1346
  as devices will be detected automatically."""
1347
+
1260
1348
  def version(self) -> str:
1261
1349
  """Get version string of the Python interface of Zurich Instruments."""
1350
+
1262
1351
  def writeDebugLog(
1263
1352
  self, severity: Literal[0, 1, 2, 3, 4, 5, 6], message: str
1264
1353
  ) -> None:
@@ -1268,6 +1357,7 @@ class ziDAQServer:
1268
1357
  severity: Debug level (trace:0, debug:1, info:2, status:3,
1269
1358
  warning:4, error:5, fatal:6). message: Message to output to the log.
1270
1359
  """
1360
+
1271
1361
  def zoomFFT(self) -> ZoomFFTModule: # Deprecated arguments not included
1272
1362
  """Create a zoomFFT Module object.
1273
1363
 
@@ -1275,16 +1365,19 @@ class ziDAQServer:
1275
1365
 
1276
1366
  Returns:
1277
1367
  Created module instance."""
1368
+
1278
1369
  @property
1279
1370
  def host(self) -> str:
1280
1371
  """The host used for the active connection.
1281
1372
 
1282
1373
  .. versionadded:: 22.08"""
1374
+
1283
1375
  @property
1284
1376
  def port(self) -> int:
1285
1377
  """The port used for the active connection.
1286
1378
 
1287
1379
  .. versionadded:: 22.08"""
1380
+
1288
1381
  @property
1289
1382
  def api_level(self) -> Literal[0, 1, 4, 5, 6]:
1290
1383
  """The ziAPI level used for the active connection.
@@ -1305,11 +1398,13 @@ class ziDiscovery:
1305
1398
 
1306
1399
  Returns:
1307
1400
  Device id."""
1401
+
1308
1402
  def findAll(self) -> List[str]:
1309
1403
  """Return a list of all discoverable devices.
1310
1404
 
1311
1405
  Returns:
1312
1406
  List of all discoverable devices."""
1407
+
1313
1408
  def get(self, dev: str) -> Dict[str, LabOneResultAny]:
1314
1409
  """Return the device properties for a given device id.
1315
1410
 
@@ -1318,6 +1413,7 @@ class ziDiscovery:
1318
1413
 
1319
1414
  Returns:
1320
1415
  Device properties."""
1416
+
1321
1417
  def setDebugLevel(self, severity: Literal[0, 1, 2, 3, 4, 5, 6]) -> None:
1322
1418
  """Set debug level.
1323
1419
 
zhinst/core/_core.so CHANGED
Binary file
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: zhinst-core
3
- Version: 24.10.65175
3
+ Version: 25.4.0.628
4
4
  Summary: Python API for Zurich Instruments Devices
5
5
  Project-URL: Documentation, https://docs.zhinst.com/labone_api_user_manual
6
6
  Author-email: Zurich Instruments AG <info@zhinst.com>
@@ -16,8 +16,6 @@ Classifier: Operating System :: POSIX :: Linux
16
16
  Classifier: Programming Language :: C++
17
17
  Classifier: Programming Language :: Python
18
18
  Classifier: Programming Language :: Python :: 3
19
- Classifier: Programming Language :: Python :: 3.7
20
- Classifier: Programming Language :: Python :: 3.8
21
19
  Classifier: Programming Language :: Python :: 3.9
22
20
  Classifier: Programming Language :: Python :: 3.10
23
21
  Classifier: Programming Language :: Python :: 3.11
@@ -25,7 +23,7 @@ Classifier: Programming Language :: Python :: 3.12
25
23
  Classifier: Programming Language :: Python :: 3.13
26
24
  Classifier: Topic :: Scientific/Engineering
27
25
  Classifier: Topic :: Software Development :: Libraries :: Python Modules
28
- Requires-Python: >=3.7
26
+ Requires-Python: >=3.9
29
27
  Requires-Dist: typing-extensions
30
28
  Requires-Dist: numpy>=1.26.0
31
29
  Description-Content-Type: text/markdown
@@ -1,13 +1,13 @@
1
1
  zhinst/core/__init__.py,sha256=7kcZ-cpfrMCGX9XHt80qoiLREUjiKp4-WQ5YXxpydbQ,177
2
- zhinst/core/__init__.pyi,sha256=ryaqvaZUIDNq8_JsibC_ak67MIE-SB7ZamIQCZrUUiI,54365
3
- zhinst/core/_core.so,sha256=3pv6hy0iI_JTESalzemwPE6Kot22xquHPD4kE18fhsU,42196320
2
+ zhinst/core/__init__.pyi,sha256=JZzpL8zp3m5Q1UuyQyfjUi1QWpDGQoginwYZEf_37QQ,54390
3
+ zhinst/core/_core.so,sha256=HZN6GxDa1wN4dXaezUgRyvIuo0SKsW2MQDrGgSyslwk,42627816
4
4
  zhinst/core/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
5
5
  zhinst/core/_tracing/__init__.pyi,sha256=mFZYfRfJ4dIZCuvnfpAV-v4ddbiXl7n-de61znyNBeQ,2431
6
6
  zhinst/core/errors/__init__.pyi,sha256=pWrLitRK5FvivD9g3MWGrt2fCSWVtSIRH6LHGS8ZAXE,957
7
7
  zhinst/ziPython/__init__.py,sha256=so5c173hrgu5vv7DwMGG7alo8pdQc1hkaHKzu97Cm-M,443
8
8
  zhinst/ziPython/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
9
9
  zhinst/ziPython/errors/__init__.py,sha256=-niezFlzHjQGSqTqRF_9oWaJTJMNdSudEZMsLsoskXk,216
10
- zhinst_core-24.10.65175.dist-info/METADATA,sha256=LetQqVHiredQSuKxhH2x6qSgZk1yPZbjtBE164u0Zgg,2143
11
- zhinst_core-24.10.65175.dist-info/WHEEL,sha256=YH5tl6ioxxf0fVsDUU8XgfxDz7tUFlU86F9B5V1Jv_w,109
12
- zhinst_core-24.10.65175.dist-info/licenses/LICENSE.txt,sha256=F4okYREnc372D8C-9kSiGKV3xLE8lMGnhnB0sJHbX70,1065
13
- zhinst_core-24.10.65175.dist-info/RECORD,,
10
+ zhinst_core-25.4.0.628.dist-info/METADATA,sha256=fYKoneA3otLBRpazQOPNP89LoAFBkBYMrJhwjE5Cfb8,2042
11
+ zhinst_core-25.4.0.628.dist-info/WHEEL,sha256=YH5tl6ioxxf0fVsDUU8XgfxDz7tUFlU86F9B5V1Jv_w,109
12
+ zhinst_core-25.4.0.628.dist-info/licenses/LICENSE.txt,sha256=F4okYREnc372D8C-9kSiGKV3xLE8lMGnhnB0sJHbX70,1065
13
+ zhinst_core-25.4.0.628.dist-info/RECORD,,