forked from ni/nimi-python
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathfunctions.py
3070 lines (3070 loc) · 174 KB
/
functions.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# -*- coding: utf-8 -*-
# This file is generated from NI-DCPower API metadata version 21.0.0d69
functions = {
'AbortWithChannels': {
'documentation': {
'description': '\nTransitions the NI-DCPower session from the Running state to the\nUncommitted state. If a sequence is running, it is stopped. Any\nconfiguration functions called after this function are not applied until\nthe niDCPower_InitiateWithChannels function is called. If power output is enabled\nwhen you call the niDCPower_AbortWithChannels function, the output channels remain\nin their current state and continue providing power.\n\nUse the niDCPower_ConfigureOutputEnabled function to disable power\noutput on a per channel basis. Use the niDCPower_reset function to\ndisable output on all channels.\n\nRefer to the `Programming\nStates <REPLACE_DRIVER_SPECIFIC_URL_1(programmingstates)>`__ topic in\nthe *NI DC Power Supplies and SMUs Help* for information about the\nspecific NI-DCPower software states.\n\n**Related Topics:**\n\n`Programming\nStates <REPLACE_DRIVER_SPECIFIC_URL_1(programmingstates)>`__\n'
},
'parameters': [
{
'direction': 'in',
'documentation': {
'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n'
},
'name': 'vi',
'type': 'ViSession'
},
{
'direction': 'in',
'name': 'channelName',
'type': 'ViConstString'
}
],
'python_name': 'abort',
'returns': 'ViStatus'
},
'CalSelfCalibrate': {
'documentation': {
'description': '\nPerforms a self-calibration upon the specified channel(s).\n\nThis function disables the output, performs several internal\ncalculations, and updates calibration values. The updated calibration\nvalues are written to the device hardware if the\nNIDCPOWER_ATTR_SELF_CALIBRATION_PERSISTENCE attribute is set to\nNIDCPOWER_VAL_WRITE_TO_EEPROM. Refer to the\nNIDCPOWER_ATTR_SELF_CALIBRATION_PERSISTENCE attribute topic for more\ninformation about the settings for this attribute.\n\nWhen calling niDCPower_CalSelfCalibrate with the PXIe-4162/4163,\nspecify all channels of your PXIe-4162/4163 with the channelName input.\nYou cannot self-calibrate a subset of PXIe-4162/4163 channels.\n\nRefer to the\n`Self-Calibration <REPLACE_DRIVER_SPECIFIC_URL_1(selfcal)>`__ topic for\nmore information about this function.\n\n**Related Topics:**\n\n`Self-Calibration <REPLACE_DRIVER_SPECIFIC_URL_1(selfcal)>`__\n',
'note': "\nThis function is not supported on all devices. Refer to `Supported\nFunctions by\nDevice <REPLACE_DRIVER_SPECIFIC_URL_2(nidcpowercref.chm',%20'supportedfunctions)>`__\nfor more information about supported devices.\n"
},
'parameters': [
{
'direction': 'in',
'documentation': {
'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n'
},
'name': 'vi',
'type': 'ViSession'
},
{
'direction': 'in',
'documentation': {
'description': '\nSpecifies the output channel(s) to which this configuration value\napplies. Specify multiple channels by using a channel list or a channel\nrange. A channel list is a comma (,) separated sequence of channel names\n(for example, 0,2 specifies channels 0 and 2). A channel range is a\nlower bound channel followed by a hyphen (-) or colon (:) followed by an\nupper bound channel (for example, 0-2 specifies channels 0, 1, and 2).\nIn the Running state, multiple output channel configurations are\nperformed sequentially based on the order specified in this parameter.\n'
},
'name': 'channelName',
'type': 'ViConstString'
}
],
'python_name': 'self_cal',
'returns': 'ViStatus'
},
'ClearLatchedOutputCutoffState': {
'documentation': {
'description': 'Clears the state of an output cutoff that was engaged.\nTo clear the state for all output cutoff reasons, use NIDCPOWER_VAL_OUTPUT_CUTOFF_REASON_ALL.\n'
},
'parameters': [
{
'direction': 'in',
'documentation': {
'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n'
},
'name': 'vi',
'type': 'ViSession'
},
{
'direction': 'in',
'documentation': {
'description': '\nSpecifies the output channel(s) to which this configuration value\napplies. Specify multiple channels by using a channel list or a channel\nrange. A channel list is a comma (,) separated sequence of channel names\n(for example, 0,2 specifies channels 0 and 2). A channel range is a\nlower bound channel followed by a hyphen (-) or colon (:) followed by an\nupper bound channel (for example, 0-2 specifies channels 0, 1, and 2).\nIn the Running state, multiple output channel configurations are\nperformed sequentially based on the order specified in this parameter.\n'
},
'name': 'channelName',
'type': 'ViConstString'
},
{
'direction': 'in',
'documentation': {
'description': 'Specifies the reasons for which to clear the output cutoff state.\n',
'table_body': [
[
'NIDCPOWER_VAL_OUTPUT_CUTOFF_REASON_ALL',
'Clears all output cutoff conditions'
],
[
'NIDCPOWER_VAL_OUTPUT_CUTOFF_REASON_VOLTAGE_OUTPUT_HIGH',
'Clears cutoffs caused when the output exceeded the high cutoff limit for voltage output'
],
[
'NIDCPOWER_VAL_OUTPUT_CUTOFF_REASON_VOLTAGE_OUTPUT_LOW',
'Clears cutoffs caused when the output fell below the low cutoff limit for voltage output'
],
[
'NIDCPOWER_VAL_OUTPUT_CUTOFF_REASON_CURRENT_MEASURE_HIGH',
'Clears cutoffs caused when the measured current exceeded the high cutoff limit for current output'
],
[
'NIDCPOWER_VAL_OUTPUT_CUTOFF_REASON_CURRENT_MEASURE_LOW',
'Clears cutoffs caused when the measured current fell below the low cutoff limit for current output'
],
[
'NIDCPOWER_VAL_OUTPUT_CUTOFF_REASON_VOLTAGE_CHANGE_HIGH',
'Clears cutoffs caused when the voltage slew rate increased beyond the positive change cutoff for voltage output'
],
[
'NIDCPOWER_VAL_OUTPUT_CUTOFF_REASON_VOLTAGE_CHANGE_LOW',
'Clears cutoffs caused when the voltage slew rate decreased beyond the negative change cutoff for voltage output'
],
[
'NIDCPOWER_VAL_OUTPUT_CUTOFF_REASON_CURRENT_CHANGE_HIGH',
'Clears cutoffs caused when the current slew rate increased beyond the positive change cutoff for current output'
],
[
'NIDCPOWER_VAL_OUTPUT_CUTOFF_REASON_CURRENT_CHANGE_LOW',
'Clears cutoffs caused when the voltage slew rate decreased beyond the negative change cutoff for current output'
]
]
},
'enum': 'OutputCutoffReason',
'name': 'outputCutoffReason',
'type': 'ViInt32'
}
],
'returns': 'ViStatus'
},
'CommitWithChannels': {
'documentation': {
'description': '\nApplies previously configured settings to the device. Calling this\nfunction moves the NI-DCPower session from the Uncommitted state into\nthe Committed state. After calling this function, modifying any\nattribute reverts the NI-DCPower session to the Uncommitted state. Use\nthe niDCPower_InitiateWithChannels function to transition to the Running state.\nRefer to the `Programming\nStates <REPLACE_DRIVER_SPECIFIC_URL_1(programmingstates)>`__ topic in\nthe *NI DC Power Supplies and SMUs Help* for details about the specific\nNI-DCPower software states.\n\n**Related Topics:**\n\n`Programming\nStates <REPLACE_DRIVER_SPECIFIC_URL_1(programmingstates)>`__\n'
},
'parameters': [
{
'direction': 'in',
'documentation': {
'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n'
},
'name': 'vi',
'type': 'ViSession'
},
{
'direction': 'in',
'name': 'channelName',
'type': 'ViConstString'
}
],
'python_name': 'commit',
'returns': 'ViStatus'
},
'ConfigureApertureTime': {
'documentation': {
'description': '\nConfigures the aperture time on the specified channel(s).\n\nThe supported values depend on the **units**. Refer to the *Aperture\nTime* topic for your device in the *NI DC Power Supplies and SMUs Help*\nfor more information. In general, devices support discrete\n**apertureTime** values, and if you configure **apertureTime** to some\nunsupported value, NI-DCPower coerces it up to the next supported value.\n\nRefer to the *Measurement Configuration and Timing* or *DC Noise\nRejection* topic for your device in the *NI DC Power Supplies and SMUs\nHelp* for more information about how to configure your measurements.\n\n**Related Topics:**\n\n`Aperture Time <REPLACE_DRIVER_SPECIFIC_URL_1(aperture)>`__\n',
'note': "\nThis function is not supported on all devices. Refer to `Supported\nFunctions by\nDevice <REPLACE_DRIVER_SPECIFIC_URL_2(nidcpowercref.chm',%20'supportedfunctions)>`__\nfor more information about supported devices.\n"
},
'parameters': [
{
'direction': 'in',
'documentation': {
'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n'
},
'name': 'vi',
'type': 'ViSession'
},
{
'direction': 'in',
'documentation': {
'description': '\nSpecifies the output channel(s) to which this configuration value\napplies. Specify multiple channels by using a channel list or a channel\nrange. A channel list is a comma (,) separated sequence of channel names\n(for example, 0,2 specifies channels 0 and 2). A channel range is a\nlower bound channel followed by a hyphen (-) or colon (:) followed by an\nupper bound channel (for example, 0-2 specifies channels 0, 1, and 2).\nIn the Running state, multiple output channel configurations are\nperformed sequentially based on the order specified in this parameter.\n'
},
'name': 'channelName',
'type': 'ViConstString'
},
{
'direction': 'in',
'documentation': {
'description': '\nSpecifies the aperture time. Refer to the *Aperture Time* topic for your\ndevice in the *NI DC Power Supplies and SMUs Help* for more information.\n'
},
'name': 'apertureTime',
'type': 'ViReal64'
},
{
'default_value': 'ApertureTimeUnits.SECONDS',
'direction': 'in',
'documentation': {
'description': '\nSpecifies the units for **apertureTime**.\n**Defined Values**:\n',
'table_body': [
[
'NIDCPOWER_VAL_SECONDS',
'Specifies seconds.'
],
[
'NIDCPOWER_VAL_POWER_LINE_CYCLES',
'Specifies Power Line Cycles.'
]
]
},
'enum': 'ApertureTimeUnits',
'name': 'units',
'type': 'ViInt32'
}
],
'returns': 'ViStatus'
},
'CreateAdvancedSequenceStepWithChannels': {
'documentation': {
'description': '\nCreates a new advanced sequence step in the advanced sequence specified\nby the Active advanced sequence. When you create an advanced sequence\nstep, each attribute you passed to the niDCPower_CreateAdvancedSequenceWithChannels\nfunction is reset to its default value for that step unless otherwise\nspecified.\n\n**Support for this Function**\n\nYou must set the source mode to Sequence to use this function.\n\nUsing the niDCPower_SetSequence function with Advanced Sequence\nfunctions is unsupported.\n\n**Related Topics**:\n\n`Advanced Sequence\nMode <REPLACE_DRIVER_SPECIFIC_URL_1(advancedsequencemode)>`__\n\n`Programming\nStates <REPLACE_DRIVER_SPECIFIC_URL_1(programmingstates)>`__\n\nniDCPower_CreateAdvancedSequenceWithChannels\n',
'note': "\nThis function is not supported on all devices. Refer to `Supported\nFunctions by\nDevice <REPLACE_DRIVER_SPECIFIC_URL_2(nidcpowercref.chm',%20'supportedfunctions)>`__\nfor more information about supported devices.\n"
},
'parameters': [
{
'direction': 'in',
'documentation': {
'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n'
},
'name': 'vi',
'type': 'ViSession'
},
{
'direction': 'in',
'name': 'channelName',
'type': 'ViConstString'
},
{
'default_value': True,
'direction': 'in',
'documentation': {
'description': 'Specifies that this current step in the active sequence is active.'
},
'name': 'setAsActiveStep',
'type': 'ViBoolean'
}
],
'python_name': 'create_advanced_sequence_step',
'returns': 'ViStatus'
},
'CreateAdvancedSequenceWithChannels': {
'codegen_method': 'private',
'documentation': {
'description': '\nCreates an empty advanced sequence. Call the\nniDCPower_CreateAdvancedSequenceStepWithChannels function to add steps to the\nactive advanced sequence.\n\nYou can create multiple advanced sequences in a session.\n\n**Support for this function**\n\nYou must set the source mode to Sequence to use this function.\n\nUsing the niDCPower_SetSequence function with Advanced Sequence\nfunctions is unsupported.\n\nUse this function in the Uncommitted or Committed programming states.\nRefer to the `Programming\nStates <REPLACE_DRIVER_SPECIFIC_URL_1(programmingstates)>`__ topic in\nthe *NI DC Power Supplies and SMUs Help* for more information about\nNI-DCPower programming states.\n\n**Related Topics**:\n\n`Advanced Sequence\nMode <REPLACE_DRIVER_SPECIFIC_URL_1(advancedsequencemode)>`__\n\n`Programming\nStates <REPLACE_DRIVER_SPECIFIC_URL_1(programmingstates)>`__\n\nniDCPower_CreateAdvancedSequenceStepWithChannels\n',
'note': "\nThis function is not supported on all devices. Refer to `Supported\nFunctions by\nDevice <REPLACE_DRIVER_SPECIFIC_URL_2(nidcpowercref.chm',%20'supportedfunctions)>`__\nfor more information about supported devices.\n"
},
'method_name_for_documentation': 'create_advanced_sequence',
'parameters': [
{
'direction': 'in',
'documentation': {
'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n'
},
'name': 'vi',
'type': 'ViSession'
},
{
'direction': 'in',
'name': 'channelName',
'type': 'ViConstString'
},
{
'direction': 'in',
'documentation': {
'description': 'Specifies the name of the sequence to create.'
},
'name': 'sequenceName',
'type': 'ViConstString'
},
{
'direction': 'in',
'documentation': {
'description': 'Specifies the number of attributes in the attributeIDs array.'
},
'name': 'attributeIdCount',
'type': 'ViInt32'
},
{
'direction': 'in',
'documentation': {
'description': '\nSpecifies the attributes you reconfigure per step in the advanced\nsequence. The following table lists which attributes can be configured\nin an advanced sequence for each NI-DCPower device that supports\nadvanced sequencing. A Yes indicates that the attribute can be configured\nin advanced sequencing. An No indicates that the attribute cannot be\nconfigured in advanced sequencing.\n',
'table_body': [
[
'NIDCPOWER_ATTR_DC_NOISE_REJECTION',
'Yes',
'No',
'Yes',
'No',
'Yes',
'No',
'No',
'Yes'
],
[
'NIDCPOWER_ATTR_APERTURE_TIME',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes'
],
[
'NIDCPOWER_ATTR_MEASURE_RECORD_LENGTH',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes'
],
[
'NIDCPOWER_ATTR_SENSE',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes'
],
[
'NIDCPOWER_ATTR_OVP_ENABLED',
'Yes',
'Yes',
'Yes',
'No',
'No',
'No',
'No',
'No'
],
[
'NIDCPOWER_ATTR_OVP_LIMIT',
'Yes',
'Yes',
'Yes',
'No',
'No',
'No',
'No',
'No'
],
[
'NIDCPOWER_ATTR_PULSE_BIAS_DELAY',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'No',
'No',
'No'
],
[
'NIDCPOWER_ATTR_PULSE_OFF_TIME',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'No',
'No',
'No'
],
[
'NIDCPOWER_ATTR_PULSE_ON_TIME',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'No',
'No',
'No'
],
[
'NIDCPOWER_ATTR_SOURCE_DELAY',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes'
],
[
'NIDCPOWER_ATTR_CURRENT_COMPENSATION_FREQUENCY',
'Yes',
'No',
'Yes',
'No',
'Yes',
'No',
'Yes',
'Yes'
],
[
'NIDCPOWER_ATTR_CURRENT_GAIN_BANDWIDTH',
'Yes',
'No',
'Yes',
'No',
'Yes',
'No',
'Yes',
'Yes'
],
[
'NIDCPOWER_ATTR_CURRENT_POLE_ZERO_RATIO',
'Yes',
'No',
'Yes',
'No',
'Yes',
'No',
'Yes',
'Yes'
],
[
'NIDCPOWER_ATTR_VOLTAGE_COMPENSATION_FREQUENCY',
'Yes',
'No',
'Yes',
'No',
'Yes',
'No',
'Yes',
'Yes'
],
[
'NIDCPOWER_ATTR_VOLTAGE_GAIN_BANDWIDTH',
'Yes',
'No',
'Yes',
'No',
'Yes',
'No',
'Yes',
'Yes'
],
[
'NIDCPOWER_ATTR_VOLTAGE_POLE_ZERO_RATIO',
'Yes',
'No',
'Yes',
'No',
'Yes',
'No',
'Yes',
'Yes'
],
[
'NIDCPOWER_ATTR_CURRENT_LEVEL',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes'
],
[
'NIDCPOWER_ATTR_CURRENT_LEVEL_RANGE',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes'
],
[
'NIDCPOWER_ATTR_VOLTAGE_LIMIT',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes'
],
[
'NIDCPOWER_ATTR_VOLTAGE_LIMIT_HIGH',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'No'
],
[
'NIDCPOWER_ATTR_VOLTAGE_LIMIT_LOW',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'No'
],
[
'NIDCPOWER_ATTR_VOLTAGE_LIMIT_RANGE',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes'
],
[
'NIDCPOWER_ATTR_CURRENT_LIMIT',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes'
],
[
'NIDCPOWER_ATTR_CURRENT_LIMIT_HIGH',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'No'
],
[
'NIDCPOWER_ATTR_CURRENT_LIMIT_LOW',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'No'
],
[
'NIDCPOWER_ATTR_CURRENT_LIMIT_RANGE',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes'
],
[
'NIDCPOWER_ATTR_VOLTAGE_LEVEL',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes'
],
[
'NIDCPOWER_ATTR_VOLTAGE_LEVEL_RANGE',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes'
],
[
'NIDCPOWER_ATTR_OUTPUT_ENABLED',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes'
],
[
'NIDCPOWER_ATTR_OUTPUT_FUNCTION',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes'
],
[
'NIDCPOWER_ATTR_OUTPUT_RESISTANCE',
'Yes',
'No',
'Yes',
'No',
'Yes',
'No',
'Yes',
'No'
],
[
'NIDCPOWER_ATTR_PULSE_BIAS_CURRENT_LEVEL',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'No',
'No',
'No'
],
[
'NIDCPOWER_ATTR_PULSE_BIAS_VOLTAGE_LIMIT',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'No',
'No',
'No'
],
[
'NIDCPOWER_ATTR_PULSE_BIAS_VOLTAGE_LIMIT_HIGH',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'No',
'No',
'No'
],
[
'NIDCPOWER_ATTR_PULSE_BIAS_VOLTAGE_LIMIT_LOW',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'No',
'No',
'No'
],
[
'NIDCPOWER_ATTR_PULSE_CURRENT_LEVEL',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'No',
'No',
'No'
],
[
'NIDCPOWER_ATTR_PULSE_CURRENT_LEVEL_RANGE',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'No',
'No',
'No'
],
[
'NIDCPOWER_ATTR_PULSE_VOLTAGE_LIMIT',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'No',
'No',
'No'
],
[
'NIDCPOWER_ATTR_PULSE_VOLTAGE_LIMIT_HIGH',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'No',
'No',
'No'
],
[
'NIDCPOWER_ATTR_PULSE_VOLTAGE_LIMIT_LOW',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'No',
'No',
'No'
],
[
'NIDCPOWER_ATTR_PULSE_VOLTAGE_LIMIT_RANGE',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'No',
'No',
'No'
],
[
'NIDCPOWER_ATTR_PULSE_BIAS_CURRENT_LIMIT',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'No',
'No',
'No'
],
[
'NIDCPOWER_ATTR_PULSE_BIAS_CURRENT_LIMIT_HIGH',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'No',
'No',
'No'
],
[
'NIDCPOWER_ATTR_PULSE_BIAS_CURRENT_LIMIT_LOW',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'No',
'No',
'No'
],
[
'NIDCPOWER_ATTR_PULSE_BIAS_VOLTAGE_LEVEL',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'No',
'No',
'No'
],
[
'NIDCPOWER_ATTR_PULSE_CURRENT_LIMIT',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'No',
'No',
'No'
],
[
'NIDCPOWER_ATTR_PULSE_CURRENT_LIMIT_HIGH',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'No',
'No',
'No'
],
[
'NIDCPOWER_ATTR_PULSE_CURRENT_LIMIT_LOW',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'No',
'No',
'No'
],
[
'NIDCPOWER_ATTR_PULSE_CURRENT_LIMIT_RANGE',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'No',
'No',
'No'
],
[
'NIDCPOWER_ATTR_PULSE_VOLTAGE_LEVEL',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'No',
'No',
'No'
],
[
'NIDCPOWER_ATTR_PULSE_VOLTAGE_LEVEL_RANGE',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'No',
'No',
'No'
],
[
'NIDCPOWER_ATTR_TRANSIENT_RESPONSE',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes',
'Yes'
]
],
'table_header': [
'Attribute',
'PXIe-4135',
'PXIe-4136',
'PXIe-4137',
'PXIe-4138',
'PXIe-4139',
'PXIe-4140/4142/4144',
'PXIe-4141/4143/4145',
'PXIe-4162/4163'
]
},
'name': 'attributeIds',
'size': {
'mechanism': 'len',
'value': 'attributeIdCount'
},
'type': 'ViInt32[]'
},
{
'direction': 'in',
'documentation': {
'description': 'Specifies that this current sequence is active.'
},
'name': 'setAsActiveSequence',
'type': 'ViBoolean'
}
],
'returns': 'ViStatus'
},
'DeleteAdvancedSequenceWithChannels': {
'documentation': {
'description': '\nDeletes a previously created advanced sequence and all the advanced\nsequence steps in the advanced sequence.\n\n**Support for this Function**\n\nYou must set the source mode to Sequence to use this function.\n\nUsing the niDCPower_SetSequence function with Advanced Sequence\nfunctions is unsupported.\n\n**Related Topics**:\n\n`Advanced Sequence\nMode <REPLACE_DRIVER_SPECIFIC_URL_1(advancedsequencemode)>`__\n\n`Programming\nStates <REPLACE_DRIVER_SPECIFIC_URL_1(programmingstates)>`__\n',
'note': "\nThis function is not supported on all devices. Refer to `Supported\nFunctions by\nDevice <REPLACE_DRIVER_SPECIFIC_URL_2(nidcpowercref.chm',%20'supportedfunctions)>`__\nfor more information about supported devices.\n"
},
'parameters': [
{
'direction': 'in',
'documentation': {
'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n'
},
'name': 'vi',
'type': 'ViSession'
},
{
'direction': 'in',
'name': 'channelName',
'type': 'ViConstString'
},
{
'direction': 'in',
'documentation': {
'description': 'specifies the name of the sequence to delete.'
},
'name': 'sequenceName',
'type': 'ViConstString'
}
],
'python_name': 'delete_advanced_sequence',
'returns': 'ViStatus'
},
'Disable': {
'documentation': {
'description': '\nThis function performs the same actions as the niDCPower_ResetWithChannels\nfunction, except that this function also immediately sets the\nNIDCPOWER_ATTR_OUTPUT_ENABLED attribute to VI_FALSE.\n\nThis function opens the output relay on devices that have an output\nrelay.\n'
},
'parameters': [
{
'direction': 'in',
'documentation': {
'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n'
},
'name': 'vi',
'type': 'ViSession'
}
],
'returns': 'ViStatus'
},
'ExportAttributeConfigurationBuffer': {
'documentation': {
'description': '\nExports the attribute configuration of the session to the specified\nconfiguration buffer.\n\nYou can export and import session attribute configurations only between\ndevices with identical model numbers and the same number of configured\nchannels.\n\nThis function verifies that the attributes you have configured for the\nsession are valid. If the configuration is invalid, NI‑DCPower returns\nan error.\n\n**Support for this Function**\n\nCalling this function in `Sequence Source\nMode <REPLACE_DRIVER_SPECIFIC_URL_1(sequencing)>`__ is unsupported.\n\n**Channel Mapping Behavior for Multichannel Sessions**\n\nWhen importing and exporting session attribute configurations between\nNI‑DCPower sessions that were initialized with different channels, the\nconfigurations of the exporting channels are mapped to the importing\nchannels in the order you specify in the **channelName** input to the\nniDCPower_InitializeWithChannels function.\n\nFor example, if your entry for **channelName** is 0,1 for the exporting\nsession and 1,2 for the importing session:\n\n- The configuration exported from channel 0 is imported into channel 1.\n- The configuration exported from channel 1 is imported into channel 2.\n\n**Related Topics:**\n\n`Using Properties and\nAttributes <REPLACE_DRIVER_SPECIFIC_URL_1(using_properties_and_attributes)>`__\n\n`Setting Properties and Attributes Before Reading\nThem <REPLACE_DRIVER_SPECIFIC_URL_1(setting_before_reading_attributes)>`__\n',
'note': '\nThis function will return an error if the total number of channels\ninitialized for the exporting session is not equal to the total number\nof channels initialized for the importing session.\n'
},
'parameters': [
{
'direction': 'in',
'documentation': {
'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n'
},
'name': 'vi',
'type': 'ViSession'
},
{
'direction': 'in',
'documentation': {
'description': '\nSpecifies the size, in bytes, of the byte array to export. If you enter\n0, this function returns the needed size.\n'
},
'name': 'size',
'type': 'ViInt32'
},
{
'direction': 'out',
'documentation': {
'description': '\nSpecifies the byte array buffer to be populated with the exported\nattribute configuration.\n'
},
'name': 'configuration',
'python_api_converter_name': 'convert_to_bytes',
'size': {
'mechanism': 'ivi-dance',
'value': 'size'
},
'type': 'ViInt8[]',
'type_in_documentation': 'bytes',
'use_array': True
}
],
'returns': 'ViStatus'
},
'ExportAttributeConfigurationFile': {
'documentation': {
'description': '\nExports the attribute configuration of the session to the specified\nfile.\n\nYou can export and import session attribute configurations only between\ndevices with identical model numbers and the same number of configured\nchannels.\n\nThis function verifies that the attributes you have configured for the\nsession are valid. If the configuration is invalid, NI‑DCPower returns\nan error.\n\n**Support for this Function**\n\nCalling this function in `Sequence Source\nMode <REPLACE_DRIVER_SPECIFIC_URL_1(sequencing)>`__ is unsupported.\n\n**Channel Mapping Behavior for Multichannel Sessions**\n\nWhen importing and exporting session attribute configurations between\nNI‑DCPower sessions that were initialized with different channels, the\nconfigurations of the exporting channels are mapped to the importing\nchannels in the order you specify in the **channelName** input to the\nniDCPower_InitializeWithChannels function.\n\nFor example, if your entry for **channelName** is 0,1 for the exporting\nsession and 1,2 for the importing session:\n\n- The configuration exported from channel 0 is imported into channel 1.\n- The configuration exported from channel 1 is imported into channel 2.\n\n**Related Topics:**\n\n`Using Properties and\nAttributes <REPLACE_DRIVER_SPECIFIC_URL_1(using_properties_and_attributes)>`__\n\n`Setting Properties and Attributes Before Reading\nThem <REPLACE_DRIVER_SPECIFIC_URL_1(setting_before_reading_attributes)>`__\n',
'note': '\nThis function will return an error if the total number of channels\ninitialized for the exporting session is not equal to the total number\nof channels initialized for the importing session.\n'
},
'parameters': [
{
'direction': 'in',
'documentation': {
'description': '\nIdentifies a particular instrument session. **vi** is obtained from the\nniDCPower_InitializeWithChannels function.\n'
},
'name': 'vi',
'type': 'ViSession'
},
{
'direction': 'in',
'documentation': {
'description': '\nSpecifies the absolute path to the file to contain the exported\nattribute configuration. If you specify an empty or relative path, this\nfunction returns an error.\n**Default file extension:** .nidcpowerconfig\n'
},
'name': 'filePath',
'type': 'ViConstString'
}
],
'returns': 'ViStatus'
},
'FancyFetchMultiple': {
'codegen_method': 'python-only',
'documentation': {
'description': '\nReturns a list of named tuples (Measurement) that were\npreviously taken and are stored in the NI-DCPower buffer. This function\nshould not be used when the NIDCPOWER_ATTR_MEASURE_WHEN attribute is\nset to NIDCPOWER_VAL_ON_DEMAND. You must first call\nniDCPower_InitiateWithChannels before calling this function.\n\nFields in Measurement:\n\n- **voltage** (float)\n- **current** (float)\n- **in_compliance** (bool)\n\n',
'note': 'This function is not supported on all devices. Refer to `Supported Functions by Device <REPLACE_DRIVER_SPECIFIC_URL_2(nidcpowercref.chm, supportedfunctions)>`__ for more information about supported devices.'
},
'method_templates': [
{
'documentation_filename': 'default_method',
'method_python_name_suffix': '',
'session_filename': 'fancy_fetch'
}
],
'parameters': [