+ All Categories
Home > Documents > NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument...

NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument...

Date post: 13-Aug-2020
Category:
Upload: others
View: 3 times
Download: 0 times
Share this document with a friend
110
niDCPower Initialize Creates a new IVI instrument driver session to the power supply specified in resource name and returns a session handle you use to identify the session in all subsequent NI-DCPower VI calls. This VI also sends initialization commands to set the power supply to the state necessary for NI-DCPower to operate. To place the power supply in a known startup state when creating a new session, set reset device to TRUE. This action is equivalent to using the niDCPower Reset VI. To open a session and leave the device in its existing configuration without passing through a transitional output state, set reset device to FALSE, and then immediately call the niDCPower Abort VI. To apply a new configuration without disrupting the output channels of the device, configure the device in Delayed Configuration mode as in the previous session changing only the desired settings, and then call the niDCPower Initiate VI. resource name specifies the resource name assigned by Measurement & Automation Explorer (MAX), for example PXI1Slot3, where PXI1Slot3 is an instrument resource name. resource name can also be a logical IVI name. id query specifies whether the device is queried to determine if the device is a valid instrument for NI-DCPower. The default is TRUE. reset device specifies whether to reset the power supply during the initialization procedure. The default is TRUE. error in (no error) describes error conditions that occur before this VI runs. status is TRUE (X) if an error occurred before this VI ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI ran. The default is FALSE. code is the error or warning code. The default is 0. If status is TRUE, code is a negative error code. If status is FALSE, code is 0 or a warning code. source describes the origin of the error or warning and is, in
Transcript
Page 1: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

niDCPowerInitializeCreatesanewIVIinstrumentdriversessiontothepowersupplyspecifiedinresourcenameandreturnsasessionhandleyouusetoidentifythesessioninallsubsequentNI-DCPowerVIcalls.ThisVIalsosendsinitializationcommandstosetthepowersupplytothestatenecessaryforNI-DCPowertooperate.Toplacethepowersupplyinaknownstartupstatewhencreatinganewsession,setresetdevicetoTRUE.ThisactionisequivalenttousingtheniDCPowerResetVI.Toopenasessionandleavethedeviceinitsexistingconfigurationwithoutpassingthroughatransitionaloutputstate,setresetdevicetoFALSE,andthenimmediatelycalltheniDCPowerAbortVI.Toapplyanewconfigurationwithoutdisruptingtheoutputchannelsofthedevice,configurethedeviceinDelayedConfigurationmodeasintheprevioussessionchangingonlythedesiredsettings,andthencalltheniDCPowerInitiateVI.

resourcenamespecifiestheresourcenameassignedbyMeasurement&AutomationExplorer(MAX),forexamplePXI1Slot3,wherePXI1Slot3isaninstrumentresourcename.resourcenamecanalsobealogicalIVIname.idqueryspecifieswhetherthedeviceisqueriedtodetermineifthedeviceisavalidinstrumentforNI-DCPower.ThedefaultisTRUE.resetdevicespecifieswhethertoresetthepowersupplyduringtheinitializationprocedure.ThedefaultisTRUE.errorin(noerror)describeserrorconditionsthatoccurbeforethisVIruns.

statusisTRUE(X)ifanerroroccurredbeforethisVIranorFALSE(checkmark)toindicateawarningorthatnoerroroccurredbeforethisVIran.ThedefaultisFALSE.codeistheerrororwarningcode.Thedefaultis0.IfstatusisTRUE,codeisanegativeerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,in

Page 2: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

mostcases,thenameoftheVIthatproducedtheerrororwarning.Thedefaultisanemptystring.

instrumenthandleoutreturnsahandlethatyouusetoidentifythesessioninallsubsequentNI-DCPowerVIcalls.erroroutcontainserrorinformation.IferrorinindicatesthatanerroroccurredbeforethisVIran,erroroutcontainsthesameerrorinformation.Otherwise,itdescribestheerrorstatusthatthisVIproduces.

statusisTRUE(X)ifanerroroccurredorFALSE(checkmark)toindicateawarningorthatnoerroroccurred.codetheerrororwarningcode.IfstatusisTRUE,codeisanon-zeroerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.

Page 3: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

niDCPowerCloseClosesthesessionspecifiedininstrumenthandleanddeallocatestheresourcesthatNI-DCPowerreserved.IfpoweroutputisenabledwhenyoucallthisVI,theoutputchannelsremainintheircurrentstateandcontinueprovidingpower.UsetheniDCPowerConfigureOutputEnabledVItodisablepoweroutputonaperchannelbasis.UsetheniDCPowerResetVItodisablepoweronalloutputchannels.

instrumenthandleidentifiesaparticularinstrumentsession.instrumenthandleisobtainedfromtheniDCPowerInitializeortheniDCPowerInitializeWithOptionsVI.errorin(noerror)describeserrorconditionsthatoccurbeforethisVIruns.

statusisTRUE(X)ifanerroroccurredbeforethisVIranorFALSE(checkmark)toindicateawarningorthatnoerroroccurredbeforethisVIran.ThedefaultisFALSE.codeistheerrororwarningcode.Thedefaultis0.IfstatusisTRUE,codeisanegativeerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.Thedefaultisanemptystring.

erroroutcontainserrorinformation.IferrorinindicatesthatanerroroccurredbeforethisVIran,erroroutcontainsthesameerrorinformation.Otherwise,itdescribestheerrorstatusthatthisVIproduces.

statusisTRUE(X)ifanerroroccurredorFALSE(checkmark)toindicateawarningorthatnoerroroccurred.codetheerrororwarningcode.IfstatusisTRUE,codeisanon-zeroerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerroror

Page 4: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

warning.

Page 5: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

niDCPowerConfigureOutputEnabledEnablesordisablesgenerationonthespecifiedchannel(s).Dependingontheselectedoutputfunction,thevoltagelevelorthecurrentlevelmustbesetinadditiontoenablingtheoutputtogeneratethedesiredlevel.RefertotheniDCPowerConfigureVoltageLevelVI,niDCPowerConfigureCurrentLevelVI,andtheniDCPowerConfigureOutputFunctionVIformoreinformationaboutconfiguringthedesiredoutputlevel.

NoteIfthedeviceisinDelayedConfigurationmode,enablingtheoutputwillnottakeeffectuntilyoucalltheniDCPowerInitiateVI.

instrumenthandleidentifiesaparticularinstrumentsession.instrumenthandleisobtainedfromtheniDCPowerInitializeortheniDCPowerInitializeWithOptionsVI.channelnamespecifiestowhichoutputchannel(s)toapplythisconfigurationvalue.Youcanspecifymultiplechannelsbyusingachannellistorachannelrange.Achannellistisacomma(,)separatedsequenceofchannelnames(e.g.0,2specifieschannels0and2).Achannelrangeisalowerboundchannelfollowedbyahyphen(-)orcolon(:)followedbyanupperboundchannel(e.g.0-2specifieschannels0,1,and2).InImmediatemode,multipleoutputchannelconfigurationsareperformedsequentiallybasedontheorderspecifiedinthisparameter.outputenabledspecifieswhethertheoutputchannelenabledordisabled.

true Enablesgenerationonthespecifiedoutputchannel(s).false Disablesgenerationonthespecifiedoutputchannel(s).

DefaultValue:false

errorin(noerror)describeserrorconditionsthatoccurbeforethisVIruns.

statusisTRUE(X)ifanerroroccurredbeforethisVIranorFALSE(checkmark)toindicateawarningorthatnoerror

Page 6: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

occurredbeforethisVIran.ThedefaultisFALSE.codeistheerrororwarningcode.Thedefaultis0.IfstatusisTRUE,codeisanegativeerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.Thedefaultisanemptystring.

instrumenthandleoutpassesthehandleusedtoidentifythesessioninallsubsequentNI-DCPowerVIcalls.erroroutcontainserrorinformation.IferrorinindicatesthatanerroroccurredbeforethisVIran,erroroutcontainsthesameerrorinformation.Otherwise,itdescribestheerrorstatusthatthisVIproduces.

statusisTRUE(X)ifanerroroccurredorFALSE(checkmark)toindicateawarningorthatnoerroroccurred.codetheerrororwarningcode.IfstatusisTRUE,codeisanon-zeroerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.

Page 7: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

niDCPowerConfigureOutputFunctionConfiguresthefunctionthedeviceattemptstogenerateforthespecifiedchannel.Details

channelnamespecifiestowhichoutputchannel(s)toapplythisconfigurationvalue.Youcanspecifymultiplechannelsbyusingachannellistorachannelrange.Achannellistisacomma(,)separatedsequenceofchannelnames(e.g.0,2specifieschannels0and2).Achannelrangeisalowerboundchannelfollowedbyahyphen(-)orcolon(:)followedbyanupperboundchannel(e.g.0-2specifieschannels0,1,and2).InImmediatemode,multipleoutputchannelconfigurationsareperformedsequentiallybasedontheorderspecifiedinthisparameter.outputfunctionconfiguresthefunctiontogenerateforthespecifiedchannel(s).

DCVoltage SetstheoutputfunctiontoDCvoltage.DCCurrent SetstheoutputfunctiontoDCcurrent.

DefaultValue:DCVoltage

errorin(noerror)describeserrorconditionsthatoccurbeforethisVIruns.

statusisTRUE(X)ifanerroroccurredbeforethisVIranorFALSE(checkmark)toindicateawarningorthatnoerroroccurredbeforethisVIran.ThedefaultisFALSE.codeistheerrororwarningcode.Thedefaultis0.IfstatusisTRUE,codeisanegativeerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.Thedefaultisanemptystring.

instrumenthandleoutpassesthehandleusedtoidentifythe

Page 8: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

sessioninallsubsequentNI-DCPowerVIcalls.erroroutcontainserrorinformation.IferrorinindicatesthatanerroroccurredbeforethisVIran,erroroutcontainsthesameerrorinformation.Otherwise,itdescribestheerrorstatusthatthisVIproduces.

statusisTRUE(X)ifanerroroccurredorFALSE(checkmark)toindicateawarningorthatnoerroroccurred.codetheerrororwarningcode.IfstatusisTRUE,codeisanon-zeroerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.

Page 9: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

DetailsWhenDCVoltageisselected,thedevicegeneratesthedesiredvoltagelevelontheoutputaslongastheoutputcurrentisbelowthecurrentlimit.ThefollowingVIscanbeusedtoconfigurethechannelwhenDCVoltageisselected:

niDCPowerConfigureVoltageLevelniDCPowerConfigureCurrentLimitniDCPowerConfigureVoltageLevelRangeniDCPowerConfigureCurrentLimitRange

WhenDCCurrentisselected,thedevicegeneratesthedesiredcurrentlevelontheoutputaslongastheoutputvoltageisbelowthevoltagelimit.ThefollowingfunctionscanbeusedtoconfigurethechannelwhenDCCurrentisselected:

niDCPowerConfigureCurrentLevelniDCPowerConfigureVoltageLimitniDCPowerConfigureCurrentLevelRangeniDCPowerConfigureVoltageLimitRange

Page 10: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

niDCPowerMeasureMultipleReturnsarraysofthemeasuredvoltageandcurrentvaluesonthespecifiedoutputchannel(s).EachcalltothisVIblocksotherVIcallsuntilthemeasurementsarereturnedfromthepowersupply.Theorderofthemeasurementsreturnedinthearraycorrespondstotheorderofthespecifiedoutputchannels.ThemeasurementspeedofthepowersupplyandtheSamplestoAveragepropertydictatesthelengthoftimethatameasurementtakes.

instrumenthandleidentifiesaparticularinstrumentsession.instrumenthandleisobtainedfromtheniDCPowerInitializeortheniDCPowerInitializeWithOptionsVI.channelnamespecifiestheoutputchannelstomeasure.Youcanspecifymultiplechannelsbyusingachannellistorachannelrange.Achannellistisacomma(,)separatedsequenceofchannelnames(e.g.0,2specifieschannels0and2).Achannelrangeisalowerboundchannelfollowedbyahyphen(-)orcolon(:)followedbyanupperboundchannel(e.g.0-2specifieschannels0,1,and2).errorin(noerror)describeserrorconditionsthatoccurbeforethisVIruns.

statusisTRUE(X)ifanerroroccurredbeforethisVIranorFALSE(checkmark)toindicateawarningorthatnoerroroccurredbeforethisVIran.ThedefaultisFALSE.codeistheerrororwarningcode.Thedefaultis0.IfstatusisTRUE,codeisanegativeerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.Thedefaultisanemptystring.

instrumenthandleoutpassesthehandleusedtoidentifythesessioninallsubsequentNI-DCPowerVIcalls.

Page 11: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

voltagemeasurementsreturnsanarrayofvoltagemeasurements.Themeasurementsinthearrayarereturnedinthesameorderasthechannelsspecifiedinchannelname.currentmeasurementsreturnsanarrayofcurrentmeasurements.Themeasurementsinthearrayarereturnedinthesameorderasthechannelsspecifiedinchannelname.erroroutcontainserrorinformation.IferrorinindicatesthatanerroroccurredbeforethisVIran,erroroutcontainsthesameerrorinformation.Otherwise,itdescribestheerrorstatusthatthisVIproduces.

statusisTRUE(X)ifanerroroccurredorFALSE(checkmark)toindicateawarningorthatnoerroroccurred.codetheerrororwarningcode.IfstatusisTRUE,codeisanon-zeroerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.

Page 12: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

niDCPowerConfigureSenseSpecifieswhethertouselocalorremotesensingoftheoutputvoltageonthespecifiedchannel(s).RefertotheDevicestopicspecifictoyourdeviceintheNIDCPowerSuppliesandSMUsHelptofindoutmoreinformationaboutsensingonsupportedchannels.

instrumenthandleidentifiesaparticularinstrumentsession.instrumenthandleisobtainedfromtheniDCPowerInitializeortheniDCPowerInitializeWithOptionsVI.channelnamespecifiestowhichoutputchannel(s)toapplythisconfigurationvalue.Youcanspecifymultiplechannelsbyusingachannellistorachannelrange.Achannellistisacomma(,)separatedsequenceofchannelnames(e.g.0,2specifieschannels0and2).Achannelrangeisalowerboundchannelfollowedbyahyphen(-)orcolon(:)followedbyanupperboundchannel(e.g.0-2specifieschannels0,1,and2).InImmediatemode,multipleoutputchannelconfigurationsareperformedsequentiallybasedontheorderspecifiedinthisparameter.sensespecifieslocalorremotesensingonthespecifiedchannel(s).

Local LocalsensingRemote Remotesensing

DefaultValue:Local

errorin(noerror)describeserrorconditionsthatoccurbeforethisVIruns.

statusisTRUE(X)ifanerroroccurredbeforethisVIranorFALSE(checkmark)toindicateawarningorthatnoerroroccurredbeforethisVIran.ThedefaultisFALSE.codeistheerrororwarningcode.Thedefaultis0.IfstatusisTRUE,codeisanegativeerrorcode.IfstatusisFALSE,codeis0orawarningcode.

Page 13: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.Thedefaultisanemptystring.

instrumenthandleoutpassesthehandleusedtoidentifythesessioninallsubsequentNI-DCPowerVIcalls.erroroutcontainserrorinformation.IferrorinindicatesthatanerroroccurredbeforethisVIran,erroroutcontainsthesameerrorinformation.Otherwise,itdescribestheerrorstatusthatthisVIproduces.

statusisTRUE(X)ifanerroroccurredorFALSE(checkmark)toindicateawarningorthatnoerroroccurred.codetheerrororwarningcode.IfstatusisTRUE,codeisanon-zeroerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.

Page 14: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

niDCPowerInitiateCommitstheconfiguredsettingstohardwareandplacesthepowersupplyinImmediatemode.AnyconfigurationcallsmadeafterthisVIareappliedimmediately.Tocommitsimultaneoushardwaresettingsonmultipleoutputchannels,calltheniDCPowerAbortVI,configurethepowersupply,andthencallthisVI.

instrumenthandleidentifiesaparticularinstrumentsession.instrumenthandleisobtainedfromtheniDCPowerInitializeortheniDCPowerInitializeWithOptionsVI.errorin(noerror)describeserrorconditionsthatoccurbeforethisVIruns.

statusisTRUE(X)ifanerroroccurredbeforethisVIranorFALSE(checkmark)toindicateawarningorthatnoerroroccurredbeforethisVIran.ThedefaultisFALSE.codeistheerrororwarningcode.Thedefaultis0.IfstatusisTRUE,codeisanegativeerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.Thedefaultisanemptystring.

instrumenthandleoutpassesthehandleusedtoidentifythesessioninallsubsequentNI-DCPowerVIcalls.erroroutcontainserrorinformation.IferrorinindicatesthatanerroroccurredbeforethisVIran,erroroutcontainsthesameerrorinformation.Otherwise,itdescribestheerrorstatusthatthisVIproduces.

statusisTRUE(X)ifanerroroccurredorFALSE(checkmark)toindicateawarningorthatnoerroroccurred.codetheerrororwarningcode.IfstatusisTRUE,codeisanon-zeroerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,in

Page 15: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

mostcases,thenameoftheVIthatproducedtheerrororwarning.

Page 16: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

niDCPowerAbortPlacesthepowersupplyinDelayedConfigurationmode.AnyconfigurationVIscalledafterthisVIarenotapplieduntiltheniDCPowerInitiateVIiscalled.IfpoweroutputisenabledwhenyoucalltheniDCPowerAbortVI,theoutputchannelsremainintheircurrentstateandcontinueprovidingpower.UsetheniDCPowerConfigureOutputEnabledVItodisablepoweroutputonaperchannelbasis.UsetheniDCPowerResetVItodisablepoweroutputonallchannels.WhileinDelayedConfigurationmode,NI-DCPowerperformsonlygenericparametervalidation.AnyconflictingconfigurationcallsarenotvalidateduntiltheniDCPowerInitiateVIiscalled.Ifthesameconfigurationissetmultipletimestodifferentvalues,NI-DCPowerusesthelastconfigurationcall.

instrumenthandleidentifiesaparticularinstrumentsession.instrumenthandleisobtainedfromtheniDCPowerInitializeortheniDCPowerInitializeWithOptionsVI.errorin(noerror)describeserrorconditionsthatoccurbeforethisVIruns.

statusisTRUE(X)ifanerroroccurredbeforethisVIranorFALSE(checkmark)toindicateawarningorthatnoerroroccurredbeforethisVIran.ThedefaultisFALSE.codeistheerrororwarningcode.Thedefaultis0.IfstatusisTRUE,codeisanegativeerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.Thedefaultisanemptystring.

instrumenthandleoutpassesthehandleusedtoidentifythesessioninallsubsequentNI-DCPowerVIcalls.erroroutcontainserrorinformation.IferrorinindicatesthatanerroroccurredbeforethisVIran,erroroutcontainsthesameerrorinformation.Otherwise,itdescribestheerrorstatusthatthisVI

Page 17: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

produces.statusisTRUE(X)ifanerroroccurredorFALSE(checkmark)toindicateawarningorthatnoerroroccurred.codetheerrororwarningcode.IfstatusisTRUE,codeisanon-zeroerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.

Page 18: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

niDCPowerPropertyNodeSetsorgetspropertiesofthedevice.RefertoUsingPropertiesandAttributesformoreinformation.

Page 19: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

Channel-BasedPropertiesToaccessachannel-basedproperty,youmustwireanActiveChannelofanNI-DCPowerpropertynode.TheActiveChannelislistedfirstinthepropertynode.Toaccessadevice-basedproperty,donotwireanActiveChannelorwireanemptystring.

Page 20: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

PropertieswithMultipleChannelsYoucanspecifymultiplechannelsbyusingachannellistorachannelrange.Achannellistisacomma(,)separatedsequenceofchannelnames(e.g.0,2specifieschannels0and2).Achannelrangeisalowerboundchannelfollowedbyahyphen(-)orcolon(:)followedbyanupperboundchannel(e.g.0-2specifieschannels0,1,and2).InImmediatemode,multipleoutputchannelconfigurationsareperformedsequentiallybasedontheorderspecifiedinActiveChannel.

Page 21: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

NI-DCPowerExpressConfiguresandgeneratesasignalusingNI-DCPowerwithNationalInstrumentsDCpowersuppliesandSMUs.

DialogBoxOptionsBlockDiagramInputsBlockDiagramOutputs

Page 22: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

DialogBoxOptionsParameter DescriptionMeasurements Displaysthevoltageandcurrentmeasurementsona

perchannelbasis.Configuration Containsthefollowingoptions:

Device—Containstheresourcenameofthedevice.Enable/Disablealloutputs—Specifieswhetheralloutputchannelsareenabledordisabled.ChannelConfiguration

Channels—Selectchannelbyhighlighting.Thechannelconfigurationforselectedchannelisdisplayed.OutputFunction—Configuresthefunctiontogenerateonthespecifiedchannel(s).OutputEnabled—Specifieswhethertheoutputisenabledordisabled.VoltageLevel(V)—Specifiesthevoltagelevel,involts,thedeviceattemptstogenerateonthespecifiedchannel(s).Validvaluesforthevoltagelevelaredefinedbythevoltagelevelrange.CurrentLimit(A)—Specifiesthecurrentlimit,inamps,fortheoutputnottoexceedwhengeneratingthedesiredvoltageonthespecifiedchannel(s).Validvaluesforcurrentlimitaredefinedbythecurrentlimitrange.VoltageLevelRange(V)—Specifiesthevoltagelevelrange,involts,forthespecifiedchannel(s).Therangedefinesthevalidvaluestowhichthevoltagelevelcanbeset.CurrentLimitRange(A)—Specifiesthecurrentlimitrange,inamps,forthespecifiedchannel(s).Therange

Page 23: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

BlockDiagramInputsParameter DescriptionClose(T) Specifieswhetherthesessiontothedeviceremainsopen

aftertheVIfinishesexecution.SetClose(T)toTRUEtocloseallreferencesandreinitializethedeviceforeachiteration.SetClose(T)toFALSEforalliterationsexceptthelastiterationforloopoptimization.ThedefaultisTRUE.

errorin DescribeserrorconditionsthatoccurbeforethisVIruns.

Page 24: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

BlockDiagramOutputsParameter DescriptionMeasuredVoltage

Returnsthevoltagevaluesmeasuredonalloutputchannels.

MeasuredCurrent

Returnsthecurrentvaluesmeasuredonalloutputchannels.

errorout Containserrorinformation.IferrorinindicatesthatanerroroccurredbeforethisExpressVIran,erroroutcontainsthesameerrorinformation.Otherwise,erroroutdescribestheerrorstatusthatthisExpressVIproduces.

Page 25: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

niDCPowerConfigureVoltageLevelConfiguresthevoltagelevelthedeviceattemptstogenerateforthespecifiedchannel(s).Thechannelmustbeenabledforthespecifiedvoltageleveltotakeeffect.RefertotheniDCPowerConfigureOutputEnabledVIformoreinformationaboutenablingtheoutputchannel.ThevoltagelevelsettingisapplicableonlyifthechannelissettotheDCVoltageoutputfunctionusingtheniDCPowerConfigureOutputFunctionVI.Thedeviceactivelyregulatesthevoltageatthespecifiedlevelunlessdoingsocausesacurrentdropgreaterthanthecurrentlimitacrossthechannels'outputterminals.

instrumenthandleidentifiesaparticularinstrumentsession.instrumenthandleisobtainedfromtheniDCPowerInitializeortheniDCPowerInitializeWithOptionsVI.channelnamespecifiestowhichoutputchannel(s)toapplythisconfigurationvalue.Youcanspecifymultiplechannelsbyusingachannellistorachannelrange.Achannellistisacomma(,)separatedsequenceofchannelnames(e.g.0,2specifieschannels0and2).Achannelrangeisalowerboundchannelfollowedbyahyphen(-)orcolon(:)followedbyanupperboundchannel(e.g.0-2specifieschannels0,1,and2).InImmediatemode,multipleoutputchannelconfigurationsareperformedsequentiallybasedontheorderspecifiedinthisparameter.voltagelevelspecifiesthevoltagelevel,involts,fortheoutputchannelgeneration.ThevalidvaluesforthisparameteraredefinedbythevoltagelevelrangethatisselectedusingtheniDCPowerConfigureVoltageLevelRangeVI.

errorin(noerror)describeserrorconditionsthatoccurbeforethisVIruns.

statusisTRUE(X)ifanerroroccurredbeforethisVIranorFALSE(checkmark)toindicateawarningorthatnoerroroccurredbeforethisVIran.ThedefaultisFALSE.

Page 26: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

codeistheerrororwarningcode.Thedefaultis0.IfstatusisTRUE,codeisanegativeerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.Thedefaultisanemptystring.

instrumenthandleoutpassesthehandleusedtoidentifythesessioninallsubsequentNI-DCPowerVIcalls.erroroutcontainserrorinformation.IferrorinindicatesthatanerroroccurredbeforethisVIran,erroroutcontainsthesameerrorinformation.Otherwise,itdescribestheerrorstatusthatthisVIproduces.

statusisTRUE(X)ifanerroroccurredorFALSE(checkmark)toindicateawarningorthatnoerroroccurred.codetheerrororwarningcode.IfstatusisTRUE,codeisanon-zeroerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.

Page 27: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

niDCPowerConfigureVoltageLevelRangeConfiguresthevoltagelevelrangeforthespecifiedchannel(s).TheconfiguredrangedefinesthevalidvaluesthevoltagelevelcanbesettousingtheniDCPowerConfigureVoltageLevelVI.ThevoltagelevelrangesettingisapplicableonlyifthechannelissettotheDCVoltageoutputfunctionusingtheniDCPowerConfigureOutputFunctionVI.UsetheVoltageLevelAutorangepropertytoenableautomaticselectionofthevoltagelevelrange.

instrumenthandleidentifiesaparticularinstrumentsession.instrumenthandleisobtainedfromtheniDCPowerInitializeortheniDCPowerInitializeWithOptionsVI.channelnamespecifiestowhichoutputchannel(s)toapplythisconfigurationvalue.Youcanspecifymultiplechannelsbyusingachannellistorachannelrange.Achannellistisacomma(,)separatedsequenceofchannelnames(e.g.0,2specifieschannels0and2).Achannelrangeisalowerboundchannelfollowedbyahyphen(-)orcolon(:)followedbyanupperboundchannel(e.g.0-2specifieschannels0,1,and2).InImmediatemode,multipleoutputchannelconfigurationsareperformedsequentiallybasedontheorderspecifiedinthisparameter.voltagelevelrangespecifiesthevoltagelevelrange,involts,onthespecifiedchannel(s).NIPXI-4110Channel VoltageLevelRange VoltageLevel0 6 0to+6V1 20 0to+20V2 20 0to-20VNIPXI-4130Channel VoltageLevelRange VoltageLevel0 6 0to+6V1 6 -6to+6V

Page 28: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

20 -20to+20V

NoteIfarangeotherthanwhatislistedintheprecedingtableisselected,itwillbecoercedtothenext-highestrange.Forexample,requestingthe10VvoltagelevelrangeonChannel1ontheNI-PXI4130coercesthevoltagelevelrangeto20V.RefertotheRangestopicintheNIDCPowerSuppliesandSMUsHelpformoreinformationaboutcoercion.

errorin(noerror)describeserrorconditionsthatoccurbeforethisVIruns.

statusisTRUE(X)ifanerroroccurredbeforethisVIranorFALSE(checkmark)toindicateawarningorthatnoerroroccurredbeforethisVIran.ThedefaultisFALSE.codeistheerrororwarningcode.Thedefaultis0.IfstatusisTRUE,codeisanegativeerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.Thedefaultisanemptystring.

instrumenthandleoutpassesthehandleusedtoidentifythesessioninallsubsequentNI-DCPowerVIcalls.erroroutcontainserrorinformation.IferrorinindicatesthatanerroroccurredbeforethisVIran,erroroutcontainsthesameerrorinformation.Otherwise,itdescribestheerrorstatusthatthisVIproduces.

statusisTRUE(X)ifanerroroccurredorFALSE(checkmark)toindicateawarningorthatnoerroroccurred.codetheerrororwarningcode.IfstatusisTRUE,codeisanon-zeroerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.

Page 29: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

niDCPowerConfigureCurrentLimitConfiguresthecurrentlimitforthespecifiedchannel(s).Thechannelmustbeenabledforthespecifiedcurrentlimittotakeeffect.RefertotheniDCPowerConfigureOutputEnabledVIformoreinformationaboutenablingtheoutputchannel.Thecurrentlimitisthecurrentthattheoutputshouldnotexceedwhengeneratingthedesiredvoltagelevel.ThecurrentlimitsettingisonlyapplicableifthechannelissettotheDCVoltageoutputfunctionusingtheniDCPowerConfigureOutputFunctionVI.

instrumenthandleidentifiesaparticularinstrumentsession.instrumenthandleisobtainedfromtheniDCPowerInitializeortheniDCPowerInitializeWithOptionsVI.channelnamespecifiestowhichoutputchannel(s)toapplythisconfigurationvalue.Youcanspecifymultiplechannelsbyusingachannellistorachannelrange.Achannellistisacomma(,)separatedsequenceofchannelnames(e.g.0,2specifieschannels0and2).Achannelrangeisalowerboundchannelfollowedbyahyphen(-)orcolon(:)followedbyanupperboundchannel(e.g.0-2specifieschannels0,1,and2).InImmediatemode,multipleoutputchannelconfigurationsareperformedsequentiallybasedontheorderspecifiedinthisparameter.currentlimitspecifiesthecurrentlimitonthespecifiedchannel(s).ThevalidvaluesforthisparameteraredefinedbythecurrentlimitrangethatisconfiguredusingtheniDCPowerConfigureCurrentLimitRangeVI.

behaviorspecifieshowtheoutputcurrentshouldbehavewhenthecurrentlimitisreached.

Regulate Thepowersupplycontrolstheoutputcurrentsothatitdoesnotexceedthecurrentlimit.Thepowersupplycontinuestogeneratepower,evenifthecurrentlimithasbeenreached.

Page 30: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

errorin(noerror)describeserrorconditionsthatoccurbeforethisVIruns.

statusisTRUE(X)ifanerroroccurredbeforethisVIranorFALSE(checkmark)toindicateawarningorthatnoerroroccurredbeforethisVIran.ThedefaultisFALSE.codeistheerrororwarningcode.Thedefaultis0.IfstatusisTRUE,codeisanegativeerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.Thedefaultisanemptystring.

instrumenthandleoutpassesthehandleusedtoidentifythesessioninallsubsequentNI-DCPowerVIcalls.erroroutcontainserrorinformation.IferrorinindicatesthatanerroroccurredbeforethisVIran,erroroutcontainsthesameerrorinformation.Otherwise,itdescribestheerrorstatusthatthisVIproduces.

statusisTRUE(X)ifanerroroccurredorFALSE(checkmark)toindicateawarningorthatnoerroroccurred.codetheerrororwarningcode.IfstatusisTRUE,codeisanon-zeroerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.

Page 31: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

niDCPowerConfigureCurrentLimitRangeConfiguresthecurrentlimitrangeforthespecifiedchannel(s).TheconfiguredrangedefinesthevalidvaluesthecurrentlimitcanbesettousingtheniDCPowerConfigureCurrentLimitVI.ThecurrentlimitrangesettingisapplicableonlyifthechannelissettotheDCVoltageoutputfunctionusingtheniDCPowerConfigureOutputFunctionVI.UsetheCurrentLimitAutorangepropertytoenableautomaticselectionofthecurrentlimitrange.

instrumenthandleidentifiesaparticularinstrumentsession.instrumenthandleisobtainedfromtheniDCPowerInitializeortheniDCPowerInitializeWithOptionsVI.channelnamespecifiestowhichoutputchannel(s)toapplythisconfigurationvalue.Youcanspecifymultiplechannelsbyusingachannellistorachannelrange.Achannellistisacomma(,)separatedsequenceofchannelnames(e.g.0,2specifieschannels0and2).Achannelrangeisalowerboundchannelfollowedbyahyphen(-)orcolon(:)followedbyanupperboundchannel(e.g.0-2specifieschannels0,1,and2).InImmediatemode,multipleoutputchannelconfigurationsareperformedsequentiallybasedontheorderspecifiedinthisparameter.currentlimitrangespecifiesthecurrentlimitrange,inamps,forthespecifiedchannel.NIPXI-4110

Channel CurrentLimitRange CurrentLimit0 1A +0.01to+1A1,2 20mA +0.20to+20mA

1A +0.01to+1A

NIPXI-4130

Channel CurrentLimitRange CurrentLimit0 1A +0.01to+1A

Page 32: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

1 200μA +4to+200μA2mA +0.04to+2mA20mA +0.40to+20mA200mA +4to+200mA2A +0.04to+2A

NoteIfarangeotherthanwhatislistedintheprecedingtableisselected,itwillbecoercedtothenext-highestrange.Forexample,requestingthe100mAcurrentlimitrangeonChannel1ontheNI-PXI4130coercesthecurrentlevelrangeto200mA.RefertotheRangestopicintheNIDCPowerSuppliesandSMUsHelpformoreinformationaboutcoercion.

errorin(noerror)describeserrorconditionsthatoccurbeforethisVIruns.

statusisTRUE(X)ifanerroroccurredbeforethisVIranorFALSE(checkmark)toindicateawarningorthatnoerroroccurredbeforethisVIran.ThedefaultisFALSE.codeistheerrororwarningcode.Thedefaultis0.IfstatusisTRUE,codeisanegativeerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.Thedefaultisanemptystring.

instrumenthandleoutpassesthehandleusedtoidentifythesessioninallsubsequentNI-DCPowerVIcalls.erroroutcontainserrorinformation.IferrorinindicatesthatanerroroccurredbeforethisVIran,erroroutcontainsthesameerrorinformation.Otherwise,itdescribestheerrorstatusthatthisVIproduces.

statusisTRUE(X)ifanerroroccurredorFALSE(checkmark)toindicateawarningorthatnoerroroccurred.codetheerrororwarningcode.IfstatusisTRUE,codeisanon-zeroerrorcode.IfstatusisFALSE,codeis0ora

Page 33: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

warningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.

Page 34: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

niDCPowerConfigureCurrentLevelConfiguresthecurrentlevelthedeviceattemptstogenerateforthespecifiedchannel(s).Thechannelmustbeenabledforthespecifiedcurrentleveltotakeeffect.RefertotheniDCPowerConfigureOutputEnabledVIformoreinformationaboutenablingtheoutputchannel.ThecurrentlevelsettingisapplicableonlyifthechannelissettotheDCCurrentoutputfunctionusingtheniDCPowerConfigureOutputFunctionVI.Thedeviceactivelyregulatesthecurrentatthespecifiedlevelunlessdoingsocausesavoltagegreaterthanthevoltagelimitacrossthechannels'outputterminals.

instrumenthandleidentifiesaparticularinstrumentsession.instrumenthandleisobtainedfromtheniDCPowerInitializeortheniDCPowerInitializeWithOptionsVI.channelnamespecifiestowhichoutputchannel(s)toapplythisconfigurationvalue.Youcanspecifymultiplechannelsbyusingachannellistorachannelrange.Achannellistisacomma(,)separatedsequenceofchannelnames(e.g.0,2specifieschannels0and2).Achannelrangeisalowerboundchannelfollowedbyahyphen(-)orcolon(:)followedbyanupperboundchannel(e.g.0-2specifieschannels0,1,and2).InImmediatemode,multipleoutputchannelconfigurationsareperformedsequentiallybasedontheorderspecifiedinthisparameter.currentlevelspecifiesthecurrentlevel,inamps,togenerateforthespecifiedchannel(s).ThevalidvaluesforthisparameteraredefinedbythecurrentlevelrangethatisselectedusingtheniDCPowerConfigureCurrentLevelRangeVI.

errorin(noerror)describeserrorconditionsthatoccurbeforethisVIruns.

statusisTRUE(X)ifanerroroccurredbeforethisVIranorFALSE(checkmark)toindicateawarningorthatnoerroroccurredbeforethisVIran.ThedefaultisFALSE.

Page 35: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

codeistheerrororwarningcode.Thedefaultis0.IfstatusisTRUE,codeisanegativeerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.Thedefaultisanemptystring.

instrumenthandleoutpassesthehandleusedtoidentifythesessioninallsubsequentNI-DCPowerVIcalls.erroroutcontainserrorinformation.IferrorinindicatesthatanerroroccurredbeforethisVIran,erroroutcontainsthesameerrorinformation.Otherwise,itdescribestheerrorstatusthatthisVIproduces.

statusisTRUE(X)ifanerroroccurredorFALSE(checkmark)toindicateawarningorthatnoerroroccurred.codetheerrororwarningcode.IfstatusisTRUE,codeisanon-zeroerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.

Page 36: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

niDCPowerConfigureCurrentLevelRangeConfiguresthecurrentlevelrangeforthespecifiedchannel(s).TheconfiguredrangedefinesthevalidvaluesthecurrentlevelcanbesettousingtheniDCPowerConfigureCurrentLevelVI.ThecurrentlevelrangesettingisapplicableonlyifthechannelissettotheDCCurrentoutputfunctionusingtheniDCPowerConfigureOutputFunctionVI.UsetheCurrentLevelAutorangepropertytoenableautomaticselectionofthecurrentlevelrange.

instrumenthandleidentifiesaparticularinstrumentsession.instrumenthandleisobtainedfromtheniDCPowerInitializeortheniDCPowerInitializeWithOptionsVI.channelnamespecifiestowhichoutputchannel(s)toapplythisconfigurationvalue.Youcanspecifymultiplechannelsbyusingachannellistorachannelrange.Achannellistisacomma(,)separatedsequenceofchannelnames(e.g.0,2specifieschannels0and2).Achannelrangeisalowerboundchannelfollowedbyahyphen(-)orcolon(:)followedbyanupperboundchannel(e.g.0-2specifieschannels0,1,and2).InImmediatemode,multipleoutputchannelconfigurationsareperformedsequentiallybasedontheorderspecifiedinthisparameter.currentlevelrangespecifiesthecurrentlevelrange,inamps,forthespecifiedchannel.NIPXI-4110

Channel CurrentLevelRange CurrentLevel0 1A +0.01to+1A1 20mA +0.20to+20mA

1A +0.01to+1A2 20mA -0.20to-20mA

1A -0.01to-1A

NIPXI-4130

Page 37: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

Channel CurrentLevelRange CurrentLevel

0 1A +0.01to+1A1 200μA +4to+200μAand-4to-200μA

2mA +0.04to+2mAand-0.04to-2mA20mA +0.40to+20mAand-0.40to-20

mA200mA +4to+200mAand-4to-200mA2A +0.04to+2Aand-0.04to-2A

NoteIfarangeotherthanwhatislistedintheprecedingtableisselected,itwillbecoercedtothenext-highestrange.Forexample,requestingthe100mAcurrentlevelrangeonChannel1ontheNI-PXI4130coercesthecurrentlevelrangeto200mA.RefertotheRangestopicintheNIDCPowerSuppliesandSMUsHelpformoreinformationaboutcoercion.

errorin(noerror)describeserrorconditionsthatoccurbeforethisVIruns.

statusisTRUE(X)ifanerroroccurredbeforethisVIranorFALSE(checkmark)toindicateawarningorthatnoerroroccurredbeforethisVIran.ThedefaultisFALSE.codeistheerrororwarningcode.Thedefaultis0.IfstatusisTRUE,codeisanegativeerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.Thedefaultisanemptystring.

instrumenthandleoutpassesthehandleusedtoidentifythesessioninallsubsequentNI-DCPowerVIcalls.erroroutcontainserrorinformation.IferrorinindicatesthatanerroroccurredbeforethisVIran,erroroutcontainsthesameerrorinformation.Otherwise,itdescribestheerrorstatusthatthisVIproduces.

Page 38: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

statusisTRUE(X)ifanerroroccurredorFALSE(checkmark)toindicateawarningorthatnoerroroccurred.codetheerrororwarningcode.IfstatusisTRUE,codeisanon-zeroerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.

Page 39: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

niDCPowerConfigureVoltageLimitConfiguresthevoltagelimitforthespecifiedchannel(s).Thechannelmustbeenabledforthespecifiedvoltagelimittotakeeffect.RefertotheniDCPowerConfigureOutputEnabledVIformoreinformationaboutenablingtheoutputchannel.Thevoltagelimitisthevoltagethattheoutputshouldnotexceedwhengeneratingthedesiredcurrentlevel.ThevoltagelimitsettingisapplicableonlyifthechannelissettotheDCCurrentoutputfunctionusingtheniDCPowerConfigureOutputFunctionVI.

instrumenthandleidentifiesaparticularinstrumentsession.instrumenthandleisobtainedfromtheniDCPowerInitializeortheniDCPowerInitializeWithOptionsVI.channelnamespecifiestowhichoutputchannel(s)toapplythisconfigurationvalue.Youcanspecifymultiplechannelsbyusingachannellistorachannelrange.Achannellistisacomma(,)separatedsequenceofchannelnames(e.g.0,2specifieschannels0and2).Achannelrangeisalowerboundchannelfollowedbyahyphen(-)orcolon(:)followedbyanupperboundchannel(e.g.0-2specifieschannels0,1,and2).InImmediatemode,multipleoutputchannelconfigurationsareperformedsequentiallybasedontheorderspecifiedinthisparameter.voltagelimitspecifiesthevoltagelimit,involts,onthespecifiedoutputchannel(s).ThevalidvaluesforthisparameteraredefinedbythevoltagelimitrangethatisconfiguredusingtheniDCPowerConfigureVoltageLimitRangeVI.

errorin(noerror)describeserrorconditionsthatoccurbeforethisVIruns.

statusisTRUE(X)ifanerroroccurredbeforethisVIranorFALSE(checkmark)toindicateawarningorthatnoerroroccurredbeforethisVIran.ThedefaultisFALSE.

Page 40: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

codeistheerrororwarningcode.Thedefaultis0.IfstatusisTRUE,codeisanegativeerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.Thedefaultisanemptystring.

instrumenthandleoutpassesthehandleusedtoidentifythesessioninallsubsequentNI-DCPowerVIcalls.erroroutcontainserrorinformation.IferrorinindicatesthatanerroroccurredbeforethisVIran,erroroutcontainsthesameerrorinformation.Otherwise,itdescribestheerrorstatusthatthisVIproduces.

statusisTRUE(X)ifanerroroccurredorFALSE(checkmark)toindicateawarningorthatnoerroroccurred.codetheerrororwarningcode.IfstatusisTRUE,codeisanon-zeroerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.

Page 41: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

niDCPowerConfigureVoltageLimitRangeConfiguresthevoltagelimitrangeforthespecifiedchannel(s).TheconfiguredrangedefinesthevalidvaluesthevoltagelimitcanbesettousingtheniDCPowerConfigureVoltageLimitVI.ThevoltagelimitrangesettingisapplicableonlyifthechannelissettotheDCCurrentoutputfunctionusingtheniDCPowerConfigureOutputFunctionVI.UsetheVoltageLimitAutorangepropertytoenableautomaticselectionofthevoltagelimitrange.

channelnamespecifiestowhichoutputchannel(s)toapplythisconfigurationvalue.Youcanspecifymultiplechannelsbyusingachannellistorachannelrange.Achannellistisacomma(,)separatedsequenceofchannelnames(e.g.0,2specifieschannels0and2).Achannelrangeisalowerboundchannelfollowedbyahyphen(-)orcolon(:)followedbyanupperboundchannel(e.g.0-2specifieschannels0,1,and2).InImmediatemode,multipleoutputchannelconfigurationsareperformedsequentiallybasedontheorderspecifiedinthisparameter.voltagelimitrangespecifiesthevoltagelimitrange,involts,onthespecifiedchannel(s).NIPXI-4110

Channel VoltageLimitRange(V) VoltageLimit(V)0 6 0to+61,2 20 0to+20

NIPXI-4130

Channel VoltageLimitRange(V) VoltageLimit(V)0 6 0to+61 6 0to+6

20 0to+20

NoteIfarangeotherthanwhatislistedinthepreceding

Page 42: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

tableisselected,itwillbecoercedtothenext-highestrange.Forexample,requestingthe10VvoltagelimitrangeonChannel1ontheNI-PXI4130coercesthevoltagelimitrangeto20V.RefertotheRangestopicintheNIDCPowerSuppliesandSMUsHelpformoreinformationaboutcoercion.

errorin(noerror)describeserrorconditionsthatoccurbeforethisVIruns.

statusisTRUE(X)ifanerroroccurredbeforethisVIranorFALSE(checkmark)toindicateawarningorthatnoerroroccurredbeforethisVIran.ThedefaultisFALSE.codeistheerrororwarningcode.Thedefaultis0.IfstatusisTRUE,codeisanegativeerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.Thedefaultisanemptystring.

instrumenthandleoutpassesthehandleusedtoidentifythesessioninallsubsequentNI-DCPowerVIcalls.erroroutcontainserrorinformation.IferrorinindicatesthatanerroroccurredbeforethisVIran,erroroutcontainsthesameerrorinformation.Otherwise,itdescribestheerrorstatusthatthisVIproduces.

statusisTRUE(X)ifanerroroccurredorFALSE(checkmark)toindicateawarningorthatnoerroroccurred.codetheerrororwarningcode.IfstatusisTRUE,codeisanon-zeroerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.

Page 43: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

niDCPowerQueryOutputStateQueriesthespecifiedoutputchanneltodetermineiftheoutputchanneliscurrentlyinthestatespecifiedbyoutputstate.

instrumenthandleidentifiesaparticularinstrumentsession.instrumenthandleisobtainedfromtheniDCPowerInitializeortheniDCPowerInitializeWithOptionsVI.channelnamespecifiestheoutputchanneltoquery.Theoutputstatemayonlybequeriedforonechannelatatime.outputstatespecifiestheoutputstateoftheoutputchannelthatisbeingqueried.

ConstantVoltage

Thechannelismaintainingaconstantvoltageatitsoutput.

ConstantCurrent

Thechannelismaintainingaconstantcurrentatitsoutput.

DefaultValue:ConstantVoltage

errorin(noerror)describeserrorconditionsthatoccurbeforethisVIruns.

statusisTRUE(X)ifanerroroccurredbeforethisVIranorFALSE(checkmark)toindicateawarningorthatnoerroroccurredbeforethisVIran.ThedefaultisFALSE.codeistheerrororwarningcode.Thedefaultis0.IfstatusisTRUE,codeisanegativeerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.Thedefaultisanemptystring.

instrumenthandleoutpassesthehandleusedtoidentifythesessioninallsubsequentNI-DCPowerVIcalls.instate?returnswhetherthepowersupplyoutputchannelisinthe

Page 44: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

specifiedstate.erroroutcontainserrorinformation.IferrorinindicatesthatanerroroccurredbeforethisVIran,erroroutcontainsthesameerrorinformation.Otherwise,itdescribestheerrorstatusthatthisVIproduces.

statusisTRUE(X)ifanerroroccurredorFALSE(checkmark)toindicateawarningorthatnoerroroccurred.codetheerrororwarningcode.IfstatusisTRUE,codeisanon-zeroerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.

Page 45: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

niDCPowerMeasureReturnsthemeasuredvalueofeitherthevoltageorcurrentonthespecifiedoutputchannel.EachcalltothisVIblocksotherVIcallsuntilthehardwarereturnsthemeasurement.ThemeasurementspeedofthepowersupplyandtheSamplestoAveragepropertydictatethelengthoftimethatameasurementtakes.Tomeasuremultipleoutputchannels,usetheniDCPowerMeasureMultipleVI.

instrumenthandleidentifiesaparticularinstrumentsession.instrumenthandleisobtainedfromtheniDCPowerInitializeortheniDCPowerInitializeWithOptionsVI.channelnamespecifiestheoutputchanneltomeasure.OnlyonemeasurementatatimemaybemadewiththeniDCPowerMeasureVI.UsetoniDCPowerMeasureMultipleVItomeasuremultiplechannelsormeasurementtypes.measurementtypespecifieswhetheravoltageorcurrentvalueshouldbemeasured.

Voltage Thepowersupplymeasuresvoltage.Current Thepowersupplymeasurescurrent.

DefaultValue:Voltage

errorin(noerror)describeserrorconditionsthatoccurbeforethisVIruns.

statusisTRUE(X)ifanerroroccurredbeforethisVIranorFALSE(checkmark)toindicateawarningorthatnoerroroccurredbeforethisVIran.ThedefaultisFALSE.codeistheerrororwarningcode.Thedefaultis0.IfstatusisTRUE,codeisanegativeerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.Thedefaultisanemptystring.

Page 46: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

instrumenthandleoutpassesthehandleusedtoidentifythesessioninallsubsequentNI-DCPowerVIcalls.measurementreturnsthevalueofthemeasurement,eitherinvoltsforvoltageorampsforcurrent.erroroutcontainserrorinformation.IferrorinindicatesthatanerroroccurredbeforethisVIran,erroroutcontainsthesameerrorinformation.Otherwise,itdescribestheerrorstatusthatthisVIproduces.

statusisTRUE(X)ifanerroroccurredorFALSE(checkmark)toindicateawarningorthatnoerroroccurred.codetheerrororwarningcode.IfstatusisTRUE,codeisanon-zeroerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.

Page 47: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

niDCPowerQueryMaxCurrentLimitQueriesthemaximumcurrentlimitonanoutputchanneliftheoutputchannelissettothespecifiedvoltagelevel.

instrumenthandleidentifiesaparticularinstrumentsession.instrumenthandleisobtainedfromtheniDCPowerInitializeortheniDCPowerInitializeWithOptionsVI.channelnamespecifiestheoutputchanneltoquery.Themaximumcurrentlimitmayonlybequeriedforonechannelatatime.voltagelevelspecifiesthevoltageleveltousewhencalculatingthemaxcurrentlimit.errorin(noerror)describeserrorconditionsthatoccurbeforethisVIruns.

statusisTRUE(X)ifanerroroccurredbeforethisVIranorFALSE(checkmark)toindicateawarningorthatnoerroroccurredbeforethisVIran.ThedefaultisFALSE.codeistheerrororwarningcode.Thedefaultis0.IfstatusisTRUE,codeisanegativeerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.Thedefaultisanemptystring.

instrumenthandleoutpassesthehandleusedtoidentifythesessioninallsubsequentNI-DCPowerVIcalls.maxcurrentlimitreturnsthemaximumcurrentlimitthatcanbesetwiththespecifiedvoltagelevel.erroroutcontainserrorinformation.IferrorinindicatesthatanerroroccurredbeforethisVIran,erroroutcontainsthesameerrorinformation.Otherwise,itdescribestheerrorstatusthatthisVIproduces.

statusisTRUE(X)ifanerroroccurredorFALSE

Page 48: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

(checkmark)toindicateawarningorthatnoerroroccurred.codetheerrororwarningcode.IfstatusisTRUE,codeisanon-zeroerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.

Page 49: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

niDCPowerQueryMaxVoltageLevelQueriesthemaximumvoltagelevelonanoutputchanneliftheoutputchannelissettothespecifiedcurrentlimit.

instrumenthandleidentifiesaparticularinstrumentsession.instrumenthandleisobtainedfromtheniDCPowerInitializeortheniDCPowerInitializeWithOptionsVI.channelnamespecifiestheoutputchanneltoquery.Themaximumvoltagelevelmayonlybequeriedforonechannelatatime.currentlimitspecifiesthecurrentlimittousewhencalculatingthemaxvoltagelevel.errorin(noerror)describeserrorconditionsthatoccurbeforethisVIruns.

statusisTRUE(X)ifanerroroccurredbeforethisVIranorFALSE(checkmark)toindicateawarningorthatnoerroroccurredbeforethisVIran.ThedefaultisFALSE.codeistheerrororwarningcode.Thedefaultis0.IfstatusisTRUE,codeisanegativeerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.Thedefaultisanemptystring.

instrumenthandleoutpassesthehandleusedtoidentifythesessioninallsubsequentNI-DCPowerVIcalls.maxvoltagelevelreturnsthemaximumvoltagelevelthatcanbesetonanoutputchannelwiththespecifiedcurrentlimit.erroroutcontainserrorinformation.IferrorinindicatesthatanerroroccurredbeforethisVIran,erroroutcontainsthesameerrorinformation.Otherwise,itdescribestheerrorstatusthatthisVIproduces.

statusisTRUE(X)ifanerroroccurredorFALSE

Page 50: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

(checkmark)toindicateawarningorthatnoerroroccurred.codetheerrororwarningcode.IfstatusisTRUE,codeisanon-zeroerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.

Page 51: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

niDCPowerQueryMinCurrentLimitQueriestheminimumcurrentlimitonanoutputchanneliftheoutputchannelissettothespecifiedvoltagelevel.

instrumenthandleidentifiesaparticularinstrumentsession.instrumenthandleisobtainedfromtheniDCPowerInitializeortheniDCPowerInitializeWithOptionsVI.channelnamespecifiestheoutputchanneltoquery.Theminimumcurrentlimitmayonlybequeriedforonechannelatatime.voltagelevelspecifiesthevoltageleveltousewhencalculatingthemincurrentlimit.errorin(noerror)describeserrorconditionsthatoccurbeforethisVIruns.

statusisTRUE(X)ifanerroroccurredbeforethisVIranorFALSE(checkmark)toindicateawarningorthatnoerroroccurredbeforethisVIran.ThedefaultisFALSE.codeistheerrororwarningcode.Thedefaultis0.IfstatusisTRUE,codeisanegativeerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.Thedefaultisanemptystring.

instrumenthandleoutpassesthehandleusedtoidentifythesessioninallsubsequentNI-DCPowerVIcalls.mincurrentlimitreturnstheminimumcurrentlimitthatcanbesetonanoutputchannelwiththespecifiedvoltagelevel.erroroutcontainserrorinformation.IferrorinindicatesthatanerroroccurredbeforethisVIran,erroroutcontainsthesameerrorinformation.Otherwise,itdescribestheerrorstatusthatthisVIproduces.

statusisTRUE(X)ifanerroroccurredorFALSE(checkmark)toindicateawarningorthatnoerroroccurred.

Page 52: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

codetheerrororwarningcode.IfstatusisTRUE,codeisanon-zeroerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.

Page 53: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

niDCPowerQueryInComplianceQueriesthedevicetoindicateifachannelisoperatingatthecompliancelimit.ThecompliancelimitisthecurrentlimitwhentheoutputfunctionissettoDCVoltage.Iftheoutputisoperatingatthecompliancelimit,theoutputreachesthecurrentlimitbeforethedesiredvoltagelevel.RefertotheniDCPowerConfigureOutputFunctionVIandtheniDCPowerConfigureCurrentLimitVIformoreinformationaboutoutputfunctionandcurrentlimit,respectively.ThecompliancelimitisthevoltagelimitwhentheoutputfunctionissettoDCCurrent.Iftheoutputisoperatingatthecompliancelimit,theoutputreachesthevoltagelimitbeforethedesiredcurrentlevel.RefertotheniDCPowerConfigureOutputFunctionVIandtheniDCPowerConfigureVoltageLimitVIformoreinformationaboutoutputandvoltagelimit,respectively.

instrumenthandleidentifiesaparticularinstrumentsession.instrumenthandleisobtainedfromtheniDCPowerInitializeortheniDCPowerInitializeWithOptionsVI.channelnamespecifiestheoutputchanneltoquery.Thecompliancestatusmayonlybequeriedforonechannelatatime.errorin(noerror)describeserrorconditionsthatoccurbeforethisVIruns.

statusisTRUE(X)ifanerroroccurredbeforethisVIranorFALSE(checkmark)toindicateawarningorthatnoerroroccurredbeforethisVIran.ThedefaultisFALSE.codeistheerrororwarningcode.Thedefaultis0.IfstatusisTRUE,codeisanegativeerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.Thedefaultisanemptystring.

instrumenthandleoutpassesthehandleusedtoidentifythesessioninallsubsequentNI-DCPowerVIcalls.

Page 54: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

incompliance?returnswhetherthepowersupplyoutputchannelisincompliance.erroroutcontainserrorinformation.IferrorinindicatesthatanerroroccurredbeforethisVIran,erroroutcontainsthesameerrorinformation.Otherwise,itdescribestheerrorstatusthatthisVIproduces.

statusisTRUE(X)ifanerroroccurredorFALSE(checkmark)toindicateawarningorthatnoerroroccurred.codetheerrororwarningcode.IfstatusisTRUE,codeisanon-zeroerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.

Page 55: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

niDCPowerInitializeExternalCalibrationIfpasswordisvalid,thisVIcreatesanewIVIinstrumentdriversessiontothepowersupplyspecifiedinresourcenameandreturnsaninstrumenthandleyouusetoidentifythepowersupplyinallsubsequentNI-DCPowerVIcalls.ThisVIalsosendsinitializationcommandstosetthepowersupplytothestatenecessaryfortheoperationofNI-DCPower.Openingacalibrationsessionalwaysperformsareset.RefertothecalibrationprocedureforthepowersupplyyouarecalibratingfordetailedinstructionsontheappropriateuseofthisVI.

resourcenamespecifiestheresourcenameassignedbyMeasurement&AutomationExplorer(MAX),forexamplePXI1Slot3,wherePXI1Slot3isaninstrumentresourcename.resourcenamecanalsobealogicalIVIname.passwordspecifiesthepasswordforopeningacalibrationsession.passwordcanbeamaximumoffouralphanumericcharacters.Theinitialpasswordisfactoryconfiguredto"NI".errorin(noerror)describeserrorconditionsthatoccurbeforethisVIruns.

statusisTRUE(X)ifanerroroccurredbeforethisVIranorFALSE(checkmark)toindicateawarningorthatnoerroroccurredbeforethisVIran.ThedefaultisFALSE.codeistheerrororwarningcode.Thedefaultis0.IfstatusisTRUE,codeisanegativeerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.Thedefaultisanemptystring.

instrumenthandleoutreturnsahandlethatyouusetoidentifythesessioninallsubsequentNI-DCPowerVIcalls.erroroutcontainserrorinformation.IferrorinindicatesthatanerroroccurredbeforethisVIran,erroroutcontainsthesameerrorinformation.Otherwise,itdescribestheerrorstatusthatthisVI

Page 56: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

produces.statusisTRUE(X)ifanerroroccurredorFALSE(checkmark)toindicateawarningorthatnoerroroccurred.codetheerrororwarningcode.IfstatusisTRUE,codeisanon-zeroerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.

Page 57: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

niDCPowerCloseExternalCalibrationClosesthesessionspecifiedininstrumenthandleanddeallocatestheresourcesthatNI-DCPowerreservedforcalibration.RefertothecalibrationprocedureforthepowersupplyyouarecalibratingfordetailedinstructionsontheappropriateuseofthisVI.IfanerroroccursbeforethisVI,calibrationcloseactiondefaultstoCancel.

instrumenthandleidentifiesaparticularinstrumentcalibrationsession.instrumenthandleisobtainedfromtheniDCPowerInitializeExternalCalibrationVI.calibrationcloseactionspecifieshowtousethecalibrationvaluesfromthissessionasthesessionisclosed.

Commit ThenewcalibrationconstantsarestoredintheEEPROM.

Cancel Theoldcalibrationconstantsarekept,andthenewonesarediscarded.

DefaultValue:Cancel

errorin(noerror)describeserrorconditionsthatoccurbeforethisVIruns.

statusisTRUE(X)ifanerroroccurredbeforethisVIranorFALSE(checkmark)toindicateawarningorthatnoerroroccurredbeforethisVIran.ThedefaultisFALSE.codeistheerrororwarningcode.Thedefaultis0.IfstatusisTRUE,codeisanegativeerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.Thedefaultisanemptystring.

erroroutcontainserrorinformation.IferrorinindicatesthatanerroroccurredbeforethisVIran,erroroutcontainsthesameerrorinformation.Otherwise,itdescribestheerrorstatusthatthisVIproduces.

Page 58: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

statusisTRUE(X)ifanerroroccurredorFALSE(checkmark)toindicateawarningorthatnoerroroccurred.codetheerrororwarningcode.IfstatusisTRUE,codeisanon-zeroerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.

Page 59: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

niDCPowerCalAdjustVoltageLevelCalculatesthecalibrationconstantsforthevoltagelevelforthespecifiedoutputchannel.ThisVIcomparesthearrayinrequestedoutputstothearrayinmeasuredoutputsandcalculatesthecalibrationconstantsforthevoltageleveloftheoutputchannel.RefertothecalibrationprocedureforthepowersupplyyouarecalibratingfordetailedinstructionsontheappropriateuseofthisVI.ThisVIcanonlybecalledinanexternalcalibrationsession.

instrumenthandleidentifiesaparticularinstrumentcalibrationsession.instrumenthandleisobtainedfromtheniDCPowerInitializeExternalCalibrationVI.channelnamespecifiestheoutputchanneltowhichthesecalibrationsettingsapply.Onlyonechannelatatimemaybecalibrated.numberofmeasurementsspecifiesthenumberofelementsinrequestedoutputsandmeasuredoutputs.requestedoutputsspecifiesanarrayoftheoutputvaluesrequestedintheniDCPowerConfigureVoltageLevelVI.measuredoutputsspecifiesanarrayoftheoutputvaluesmeasuredbyanexternalprecisiondigitalmultimeter.rangespecifiestherangetocalibratewiththesesettings.errorin(noerror)describeserrorconditionsthatoccurbeforethisVIruns.

statusisTRUE(X)ifanerroroccurredbeforethisVIranorFALSE(checkmark)toindicateawarningorthatnoerroroccurredbeforethisVIran.ThedefaultisFALSE.codeistheerrororwarningcode.Thedefaultis0.IfstatusisTRUE,codeisanegativeerrorcode.IfstatusisFALSE,codeis0orawarningcode.

Page 60: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.Thedefaultisanemptystring.

instrumenthandleoutpassesthehandleusedtoidentifythesessioninallsubsequentNI-DCPowerVIcalls.erroroutcontainserrorinformation.IferrorinindicatesthatanerroroccurredbeforethisVIran,erroroutcontainsthesameerrorinformation.Otherwise,itdescribestheerrorstatusthatthisVIproduces.

statusisTRUE(X)ifanerroroccurredorFALSE(checkmark)toindicateawarningorthatnoerroroccurred.codetheerrororwarningcode.IfstatusisTRUE,codeisanon-zeroerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.

Page 61: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

niDCPowerCalAdjustVoltageMeasurementCalculatesthecalibrationconstantsforthevoltagemeasurementsreturnedbytheniDCPowerMeasureVIforthespecifiedoutputchannel.ThisVIcomparesthearrayinreportedoutputstothearrayinmeasuredoutputsandcalculatesthecalibrationconstantsforthevoltagemeasurementsreturnedbytheniDCPowerMeasureVI.RefertothecalibrationprocedureforthepowersupplyyouarecalibratingfordetailedinstructionsontheappropriateuseofthisVI.ThisVIcanonlybecalledinanexternalcalibrationsession.

instrumenthandleidentifiesaparticularinstrumentcalibrationsession.instrumenthandleisobtainedfromtheniDCPowerInitializeExternalCalibrationVI.channelnamespecifiestheoutputchanneltowhichthesecalibrationsettingsapply.Onlyonechannelatatimemaybecalibrated.numberofmeasurementsspecifiesthenumberofelementsinrequestedoutputsandmeasuredoutputs.reportedoutputsspecifiesanarrayoftheoutputvaluesthatwerereturnedbytheniDCPowerMeasureVI.measuredoutputsspecifiesanarrayoftheoutputvaluesmeasuredbyanexternalprecisiondigitalmultimeter.rangespecifiestherangetocalibratewiththesesettings.errorin(noerror)describeserrorconditionsthatoccurbeforethisVIruns.

statusisTRUE(X)ifanerroroccurredbeforethisVIranorFALSE(checkmark)toindicateawarningorthatnoerroroccurredbeforethisVIran.ThedefaultisFALSE.codeistheerrororwarningcode.Thedefaultis0.IfstatusisTRUE,codeisanegativeerrorcode.IfstatusisFALSE,code

Page 62: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

is0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.Thedefaultisanemptystring.

instrumenthandleoutpassesthehandleusedtoidentifythesessioninallsubsequentNI-DCPowerVIcalls.erroroutcontainserrorinformation.IferrorinindicatesthatanerroroccurredbeforethisVIran,erroroutcontainsthesameerrorinformation.Otherwise,itdescribestheerrorstatusthatthisVIproduces.

statusisTRUE(X)ifanerroroccurredorFALSE(checkmark)toindicateawarningorthatnoerroroccurred.codetheerrororwarningcode.IfstatusisTRUE,codeisanon-zeroerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.

Page 63: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

niDCPowerCalAdjustCurrentLimitCalculatesthecalibrationconstantsforthecurrentlimitforthespecifiedoutputchannelandrange.ThisVIcomparesthearrayinrequestedoutputstothearrayinmeasuredoutputsandcalculatesthecalibrationconstantsforthecurrentlimitreturnedbythepowersupply.RefertothecalibrationprocedureforthepowersupplyyouarecalibratingfordetailedinstructionsontheappropriateuseofthisVI.ThisVIcanonlybecalledfromanexternalcalibrationsession.

instrumenthandleidentifiesaparticularinstrumentcalibrationsession.instrumenthandleisobtainedfromtheniDCPowerInitializeExternalCalibrationVI.channelnamespecifiestheoutputchanneltowhichthesecalibrationsettingsapply.Onlyonechannelatatimemaybecalibrated.numberofmeasurementsspecifiesthenumberofelementsinrequestedoutputsandmeasuredoutputs.rangespecifiestherangetocalibratewiththesesettings.requestedoutputsspecifiesanarrayoftheoutputvaluesrequestedintheniDCPowerConfigureCurrentLimitVI.measuredoutputsspecifiesanarrayoftheoutputvaluesmeasuredbyanexternalprecisiondigitalmultimeter.errorin(noerror)describeserrorconditionsthatoccurbeforethisVIruns.

statusisTRUE(X)ifanerroroccurredbeforethisVIranorFALSE(checkmark)toindicateawarningorthatnoerroroccurredbeforethisVIran.ThedefaultisFALSE.codeistheerrororwarningcode.Thedefaultis0.IfstatusisTRUE,codeisanegativeerrorcode.IfstatusisFALSE,codeis0orawarningcode.

Page 64: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.Thedefaultisanemptystring.

instrumenthandleoutpassesthehandleusedtoidentifythesessioninallsubsequentNI-DCPowerVIcalls.erroroutcontainserrorinformation.IferrorinindicatesthatanerroroccurredbeforethisVIran,erroroutcontainsthesameerrorinformation.Otherwise,itdescribestheerrorstatusthatthisVIproduces.

statusisTRUE(X)ifanerroroccurredorFALSE(checkmark)toindicateawarningorthatnoerroroccurred.codetheerrororwarningcode.IfstatusisTRUE,codeisanon-zeroerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.

Page 65: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

niDCPowerCalAdjustCurrentMeasurementCalibratesthecurrentmeasurementsreturnedbytheniDCPowerMeasureVIforthespecifiedoutputchannel.ThisVIcalculatesthecalibrationconstantsforthearrayinreportedoutputstothearrayinmeasuredoutputsandcalculatesthecalibrationconstantsforthecurrentmeasurementsreturnedbytheniDCPowerMeasureVI.RefertothecalibrationprocedureforthepowersupplyyouarecalibratingfordetailedinstructionsontheappropriateuseofthisVI.ThisVIcanonlybecalledinanexternalcalibrationsession.

instrumenthandleidentifiesaparticularinstrumentcalibrationsession.instrumenthandleisobtainedfromtheniDCPowerInitializeExternalCalibrationVI.channelnamespecifiestheoutputchanneltowhichthesecalibrationsettingsapply.Onlyonechannelatatimemaybecalibrated.numberofmeasurementsspecifiesthenumberofelementsinreportedoutputsandmeasuredoutputs.rangespecifiestherangetocalibratewiththesesettings.reportedoutputsspecifiesanarrayoftheoutputvaluesthatwerereturnedbytheniDCPowerMeasureVI.measuredoutputsspecifiesanarrayoftheoutputvaluesmeasuredbyanexternalprecisiondigitalmultimeter.errorin(noerror)describeserrorconditionsthatoccurbeforethisVIruns.

statusisTRUE(X)ifanerroroccurredbeforethisVIranorFALSE(checkmark)toindicateawarningorthatnoerroroccurredbeforethisVIran.ThedefaultisFALSE.codeistheerrororwarningcode.Thedefaultis0.IfstatusisTRUE,codeisanegativeerrorcode.IfstatusisFALSE,code

Page 66: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

is0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.Thedefaultisanemptystring.

instrumenthandleoutpassesthehandleusedtoidentifythesessioninallsubsequentNI-DCPowerVIcalls.erroroutcontainserrorinformation.IferrorinindicatesthatanerroroccurredbeforethisVIran,erroroutcontainsthesameerrorinformation.Otherwise,itdescribestheerrorstatusthatthisVIproduces.

statusisTRUE(X)ifanerroroccurredorFALSE(checkmark)toindicateawarningorthatnoerroroccurred.codetheerrororwarningcode.IfstatusisTRUE,codeisanon-zeroerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.

Page 67: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

niDCPowerChangeExtCalPasswordChangesthepasswordthatisrequiredtoinitializeanexternalcalibrationsession.Thepasswordcanbeamaximumoffouralphanumericcharacters.IfyoucallthisVIinaregularsession,passwordischangedimmediately.IfyoucallthisVIinanexternalcalibrationsession,passwordischangedonlyafteryouclosethesessionusingtheniDCPowerCloseExternalCalibrationVIwithcalibrationcloseactionsettoCommit.

instrumenthandleidentifiesaparticularinstrumentcalibrationsession.instrumenthandleisobtainedfromtheniDCPowerInitializeExternalCalibrationVI.oldpasswordspecifiesthepreviouspasswordusedtoprotectthecalibrationvalues.newpasswordspecifiesthenewpasswordtousetoprotectthecalibrationvalues.errorin(noerror)describeserrorconditionsthatoccurbeforethisVIruns.

statusisTRUE(X)ifanerroroccurredbeforethisVIranorFALSE(checkmark)toindicateawarningorthatnoerroroccurredbeforethisVIran.ThedefaultisFALSE.codeistheerrororwarningcode.Thedefaultis0.IfstatusisTRUE,codeisanegativeerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.Thedefaultisanemptystring.

instrumenthandleoutpassesthehandleusedtoidentifythesessioninallsubsequentNI-DCPowerVIcalls.erroroutcontainserrorinformation.IferrorinindicatesthatanerroroccurredbeforethisVIran,erroroutcontainsthesameerrorinformation.Otherwise,itdescribestheerrorstatusthatthisVI

Page 68: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

produces.statusisTRUE(X)ifanerroroccurredorFALSE(checkmark)toindicateawarningorthatnoerroroccurred.codetheerrororwarningcode.IfstatusisTRUE,codeisanon-zeroerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.

Page 69: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

niDCPowerGetExtCalRecommendedIntervalReturnstherecommendedmaximuminterval,inmonths,betweenexternalcalibrations.

instrumenthandleidentifiesaparticularinstrumentcalibrationsession.instrumenthandleisobtainedfromtheniDCPowerInitializeExternalCalibrationVI.errorin(noerror)describeserrorconditionsthatoccurbeforethisVIruns.

statusisTRUE(X)ifanerroroccurredbeforethisVIranorFALSE(checkmark)toindicateawarningorthatnoerroroccurredbeforethisVIran.ThedefaultisFALSE.codeistheerrororwarningcode.Thedefaultis0.IfstatusisTRUE,codeisanegativeerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.Thedefaultisanemptystring.

instrumenthandleoutpassesthehandleusedtoidentifythesessioninallsubsequentNI-DCPowerVIcalls.monthsspecifiestherecommendedmaximuminterval,inmonths,betweenexternalcalibrations.erroroutcontainserrorinformation.IferrorinindicatesthatanerroroccurredbeforethisVIran,erroroutcontainsthesameerrorinformation.Otherwise,itdescribestheerrorstatusthatthisVIproduces.

statusisTRUE(X)ifanerroroccurredorFALSE(checkmark)toindicateawarningorthatnoerroroccurred.codetheerrororwarningcode.IfstatusisTRUE,codeisanon-zeroerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,in

Page 70: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

mostcases,thenameoftheVIthatproducedtheerrororwarning.

Page 71: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

niDCPowerGetExtCalLastDateAndTimeReturnsthedateandtimeofthelastsuccessfulcalibration.Thetimereturnedis24-hour(military)localtime;forexample,ifthepowersupplywascalibratedat2:30PM,thisVIreturns14forhoursand30forminutes.

instrumenthandleidentifiesaparticularinstrumentcalibrationsession.instrumenthandleisobtainedfromtheniDCPowerInitializeExternalCalibrationVI.errorin(noerror)describeserrorconditionsthatoccurbeforethisVIruns.

statusisTRUE(X)ifanerroroccurredbeforethisVIranorFALSE(checkmark)toindicateawarningorthatnoerroroccurredbeforethisVIran.ThedefaultisFALSE.codeistheerrororwarningcode.Thedefaultis0.IfstatusisTRUE,codeisanegativeerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.Thedefaultisanemptystring.

instrumenthandleoutpassesthehandleusedtoidentifythesessioninallsubsequentNI-DCPowerVIcalls.yearreturnstheyearinwhichthepowersupplywaslastcalibrated.monthreturnsthemonthinwhichthepowersupplywaslastcalibrated.dayreturnsthedayonwhichthepowersupplywaslastcalibrated.hourreturnsthehour(in24-hourtime)inwhichthepowersupplywaslastcalibrated.minutereturnstheminuteinwhichthepowersupplywaslastcalibrated.

Page 72: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

erroroutcontainserrorinformation.IferrorinindicatesthatanerroroccurredbeforethisVIran,erroroutcontainsthesameerrorinformation.Otherwise,itdescribestheerrorstatusthatthisVIproduces.

statusisTRUE(X)ifanerroroccurredorFALSE(checkmark)toindicateawarningorthatnoerroroccurred.codetheerrororwarningcode.IfstatusisTRUE,codeisanon-zeroerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.

Page 73: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

niDCPowerGetCalUserDefinedInfoMaxSizeReturnsthemaximumnumberofcharactersthatcanbeusedtostoreuser-definedinformationinthepowersupplyonboardEEPROM.

instrumenthandleidentifiesaparticularinstrumentsession.instrumenthandleisobtainedfromtheniDCPowerInitializeortheniDCPowerInitializeWithOptionsVI.errorin(noerror)describeserrorconditionsthatoccurbeforethisVIruns.

statusisTRUE(X)ifanerroroccurredbeforethisVIranorFALSE(checkmark)toindicateawarningorthatnoerroroccurredbeforethisVIran.ThedefaultisFALSE.codeistheerrororwarningcode.Thedefaultis0.IfstatusisTRUE,codeisanegativeerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.Thedefaultisanemptystring.

instrumenthandleoutpassesthehandleusedtoidentifythesessioninallsubsequentNI-DCPowerVIcalls.infosizereturnsthenumberofcharactersthatcanbestoredinthepowersupplyonboardEEPROM.erroroutcontainserrorinformation.IferrorinindicatesthatanerroroccurredbeforethisVIran,erroroutcontainsthesameerrorinformation.Otherwise,itdescribestheerrorstatusthatthisVIproduces.

statusisTRUE(X)ifanerroroccurredorFALSE(checkmark)toindicateawarningorthatnoerroroccurred.codetheerrororwarningcode.IfstatusisTRUE,codeisanon-zeroerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,in

Page 74: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

mostcases,thenameoftheVIthatproducedtheerrororwarning.

Page 75: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

niDCPowerSetCalUserDefinedInfoStoresauser-definedstringofcharactersinthepowersupplyonboardEEPROM.Ifthestringislongerthanthemaximumallowablesize,itistruncated.ThisVIoverwritesanyexistinguser-definedinformation.IfyoucallthisVIinaregularsession,infoisimmediatelychanged.IfyoucallthisVIinanexternalcalibrationsession,infoischangedonlyafteryouclosethesessionusingtheniDCPowerCloseExternalCalibrationVIwithcalibrationcloseactionsettoCommit.

instrumenthandleidentifiesaparticularinstrumentsession.instrumenthandleisobtainedfromtheniDCPowerInitializeortheniDCPowerInitializeWithOptionsVI.infospecifiesthestringtostoreinthepowersupplyonboardEEPROM.errorin(noerror)describeserrorconditionsthatoccurbeforethisVIruns.

statusisTRUE(X)ifanerroroccurredbeforethisVIranorFALSE(checkmark)toindicateawarningorthatnoerroroccurredbeforethisVIran.ThedefaultisFALSE.codeistheerrororwarningcode.Thedefaultis0.IfstatusisTRUE,codeisanegativeerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.Thedefaultisanemptystring.

instrumenthandleoutpassesthehandleusedtoidentifythesessioninallsubsequentNI-DCPowerVIcalls.erroroutcontainserrorinformation.IferrorinindicatesthatanerroroccurredbeforethisVIran,erroroutcontainsthesameerrorinformation.Otherwise,itdescribestheerrorstatusthatthisVIproduces.

statusisTRUE(X)ifanerroroccurredorFALSE(checkmark)toindicateawarningorthatnoerroroccurred.

Page 76: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

codetheerrororwarningcode.IfstatusisTRUE,codeisanon-zeroerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.

Page 77: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

niDCPowerGetCalUserDefinedInfoReturnstheuser-definedinformationinthepowersupplyonboardEEPROM.

instrumenthandleidentifiesaparticularinstrumentcalibrationsession.instrumenthandleisobtainedfromtheniDCPowerInitializeExternalCalibrationVI.errorin(noerror)describeserrorconditionsthatoccurbeforethisVIruns.

statusisTRUE(X)ifanerroroccurredbeforethisVIranorFALSE(checkmark)toindicateawarningorthatnoerroroccurredbeforethisVIran.ThedefaultisFALSE.codeistheerrororwarningcode.Thedefaultis0.IfstatusisTRUE,codeisanegativeerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.Thedefaultisanemptystring.

instrumenthandleoutpassesthehandleusedtoidentifythesessioninallsubsequentNI-DCPowerVIcalls.inforeturnstheuser-definedinformationstoredinthepowersupplyonboardEEPROM.erroroutcontainserrorinformation.IferrorinindicatesthatanerroroccurredbeforethisVIran,erroroutcontainsthesameerrorinformation.Otherwise,itdescribestheerrorstatusthatthisVIproduces.

statusisTRUE(X)ifanerroroccurredorFALSE(checkmark)toindicateawarningorthatnoerroroccurred.codetheerrororwarningcode.IfstatusisTRUE,codeisanon-zeroerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,in

Page 78: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

mostcases,thenameoftheVIthatproducedtheerrororwarning.

Page 79: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

niDCPowerReadCurrentTemperatureReturnsthecurrentonboardtemperature,indegreesCelsius,ofthepowersupply.

instrumenthandleidentifiesaparticularinstrumentsession.instrumenthandleisobtainedfromtheniDCPowerInitializeortheniDCPowerInitializeWithOptionsVI.errorin(noerror)describeserrorconditionsthatoccurbeforethisVIruns.

statusisTRUE(X)ifanerroroccurredbeforethisVIranorFALSE(checkmark)toindicateawarningorthatnoerroroccurredbeforethisVIran.ThedefaultisFALSE.codeistheerrororwarningcode.Thedefaultis0.IfstatusisTRUE,codeisanegativeerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.Thedefaultisanemptystring.

instrumenthandleoutpassesthehandleusedtoidentifythesessioninallsubsequentNI-DCPowerVIcalls.temperaturereturnstheonboardtemperature,indegreesCelsius,ofthepowersupply.erroroutcontainserrorinformation.IferrorinindicatesthatanerroroccurredbeforethisVIran,erroroutcontainsthesameerrorinformation.Otherwise,itdescribestheerrorstatusthatthisVIproduces.

statusisTRUE(X)ifanerroroccurredorFALSE(checkmark)toindicateawarningorthatnoerroroccurred.codetheerrororwarningcode.IfstatusisTRUE,codeisanon-zeroerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,in

Page 80: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

mostcases,thenameoftheVIthatproducedtheerrororwarning.

Page 81: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

niDCPowerGetExtCalLastTempReturnstheonboardtemperatureofthepowersupply,indegreesCelsius,duringthelastsuccessfulexternalcalibration.

instrumenthandleidentifiesaparticularinstrumentcalibrationsession.instrumenthandleisobtainedfromtheniDCPowerInitializeExternalCalibrationVI.errorin(noerror)describeserrorconditionsthatoccurbeforethisVIruns.

statusisTRUE(X)ifanerroroccurredbeforethisVIranorFALSE(checkmark)toindicateawarningorthatnoerroroccurredbeforethisVIran.ThedefaultisFALSE.codeistheerrororwarningcode.Thedefaultis0.IfstatusisTRUE,codeisanegativeerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.Thedefaultisanemptystring.

instrumenthandleoutpassesthehandleusedtoidentifythesessioninallsubsequentNI-DCPowerVIcalls.temperaturereturnstheonboardtemperature,indegreesCelsius,ofthepowersupplyduringthelastsuccessfulexternalcalibration.erroroutcontainserrorinformation.IferrorinindicatesthatanerroroccurredbeforethisVIran,erroroutcontainsthesameerrorinformation.Otherwise,itdescribestheerrorstatusthatthisVIproduces.

statusisTRUE(X)ifanerroroccurredorFALSE(checkmark)toindicateawarningorthatnoerroroccurred.codetheerrororwarningcode.IfstatusisTRUE,codeisanon-zeroerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,in

Page 82: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

mostcases,thenameoftheVIthatproducedtheerrororwarning.

Page 83: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

niDCPowerInitializeWithOptionsCreatesanewIVIinstrumentdriversessiontothepowersupplyspecifiedinresourcenameandreturnsasessionhandleyouusetoidentifythepowersupplyinallsubsequentNI-DCPowerVIcalls.WiththisVI,youcanoptionallysettheinitialstateofthefollowingsessionproperties:Simulate,DriverSetup,RangeCheck,QueryInstrumentStatus,Cache,andRecordValueCoercions.ThisVIalsosendsinitializationcommandstosetthepowersupplytothestatenecessaryforNI-DCPowertooperate.Toplacethepowersupplyinaknownstartupstatewhencreatinganewsession,setresetdevicetoTRUE.ThisactionisequivalenttousingtheniDCPowerResetVI.Toopenasessionandleavethedeviceinitsexistingconfigurationwithoutpassingthroughatransitionaloutputstate,setresetdevicetoFALSE,andthenimmediatelycalltheniDCPowerAbortVI.Toapplyanewconfigurationwithoutdisruptingtheoutputchannelsofthedevice,configurethedeviceinDelayedConfigurationmodeasintheprevioussessionchangingonlythedesiredsettings,andthencalltheniDCPowerInitiateVI.

resourcenamespecifiestheresourcenameassignedbyMeasurement&AutomationExplorer(MAX),forexamplePXI1Slot3,wherePXI1Slot3isaninstrumentresourcename.resourcenamecanalsobealogicalIVIname.idqueryspecifieswhetherthedeviceisqueriedtodetermineifthedeviceisavalidinstrumentforNI-DCPower.ThedefaultisTRUE.resetdevicespecifieswhethertoresetthepowersupplyduringtheinitializationprocedure.ThedefaultisTRUE.optionstringspecifiestheinitialvalueofcertainpropertiesforthesession.Thesyntaxforoptionstringisalistofpropertieswithanassignedvaluewhere1isTRUEand0isFALSE.Eachproperty/valuecombinationisdelimitedwithacomma(,),asshowninthefollowingexample:Simulate=0,RangeCheck=1,QueryInstrStatus=0,Cache=1

Page 84: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

Ifyoudonotwirethisinputorpassanemptystring,thesessionassignsthedefaultvalues,shownintheprecedingexample,fortheseproperties.Youdonothavetospecifyavalueforalltheproperties.Ifyoudonotspecifyavalueforaproperty,thedefaultvalueisused.Formoreinformationaboutsimulatingadevice,refertoSimulatingaPowerSupplyorSMU.

errorin(noerror)describeserrorconditionsthatoccurbeforethisVIruns.

statusisTRUE(X)ifanerroroccurredbeforethisVIranorFALSE(checkmark)toindicateawarningorthatnoerroroccurredbeforethisVIran.ThedefaultisFALSE.codeistheerrororwarningcode.Thedefaultis0.IfstatusisTRUE,codeisanegativeerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.Thedefaultisanemptystring.

instrumenthandleoutreturnsahandlethatyouusetoidentifythesessioninallsubsequentNI-DCPowerVIcalls.erroroutcontainserrorinformation.IferrorinindicatesthatanerroroccurredbeforethisVIran,erroroutcontainsthesameerrorinformation.Otherwise,itdescribestheerrorstatusthatthisVIproduces.

statusisTRUE(X)ifanerroroccurredorFALSE(checkmark)toindicateawarningorthatnoerroroccurred.codetheerrororwarningcode.IfstatusisTRUE,codeisanon-zeroerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.

Page 85: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

niDCPowerDisablePlacesthepowersupplyinaquiescentstatewhereithasminimalornoimpactonthesystemtowhichitisconnected.Thepoweroutputandallexportedsignalsaredisabled.ThisVIperformsthesameactionsastheniDCPowerResetVI.

instrumenthandleidentifiesaparticularinstrumentsession.instrumenthandleisobtainedfromtheniDCPowerInitializeortheniDCPowerInitializeWithOptionsVI.errorin(noerror)describeserrorconditionsthatoccurbeforethisVIruns.

statusisTRUE(X)ifanerroroccurredbeforethisVIranorFALSE(checkmark)toindicateawarningorthatnoerroroccurredbeforethisVIran.ThedefaultisFALSE.codeistheerrororwarningcode.Thedefaultis0.IfstatusisTRUE,codeisanegativeerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.Thedefaultisanemptystring.

instrumenthandleoutpassesthehandleusedtoidentifythesessioninallsubsequentNI-DCPowerVIcalls.erroroutcontainserrorinformation.IferrorinindicatesthatanerroroccurredbeforethisVIran,erroroutcontainsthesameerrorinformation.Otherwise,itdescribestheerrorstatusthatthisVIproduces.

statusisTRUE(X)ifanerroroccurredorFALSE(checkmark)toindicateawarningorthatnoerroroccurred.codetheerrororwarningcode.IfstatusisTRUE,codeisanon-zeroerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerroror

Page 86: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

warning.

Page 87: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

niDCPowerResetResetsthepowersupplytoaknownstate.ThisVIdisablespowergeneration,resetssessionpropertiestotheirdefaultvalues,clearserrorssuchasovertemperatureandunexpectedlossofauxiliarypower,commitsthesessionproperties,andleavesthesessioninImmediatemode.

instrumenthandleidentifiesaparticularinstrumentsession.instrumenthandleisobtainedfromtheniDCPowerInitializeortheniDCPowerInitializeWithOptionsVI.errorin(noerror)describeserrorconditionsthatoccurbeforethisVIruns.

statusisTRUE(X)ifanerroroccurredbeforethisVIranorFALSE(checkmark)toindicateawarningorthatnoerroroccurredbeforethisVIran.ThedefaultisFALSE.codeistheerrororwarningcode.Thedefaultis0.IfstatusisTRUE,codeisanegativeerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.Thedefaultisanemptystring.

instrumenthandleoutpassesthehandleusedtoidentifythesessioninallsubsequentNI-DCPowerVIcalls.erroroutcontainserrorinformation.IferrorinindicatesthatanerroroccurredbeforethisVIran,erroroutcontainsthesameerrorinformation.Otherwise,itdescribestheerrorstatusthatthisVIproduces.

statusisTRUE(X)ifanerroroccurredorFALSE(checkmark)toindicateawarningorthatnoerroroccurred.codetheerrororwarningcode.IfstatusisTRUE,codeisanon-zeroerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,in

Page 88: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

mostcases,thenameoftheVIthatproducedtheerrororwarning.

Page 89: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

niDCPowerResetDeviceResetsthepowersupplytoaknownstate.ThisVIdisablespowergeneration,resetssessionpropertiestotheirdefaultvalues,clearserrorssuchasovertemperatureandunexpectedlossofauxiliarypower,commitsthesessionproperties,andleavesthesessioninImmediatemode.ThisVIalsoperformsahardresetonthedeviceanddriversoftware.ThisVIhasthesamefunctionalityasusingresetinMeasurement&AutomationExplorer.

instrumenthandleidentifiesaparticularinstrumentsession.instrumenthandleisobtainedfromtheniDCPowerInitializeortheniDCPowerInitializeWithOptionsVI.errorin(noerror)describeserrorconditionsthatoccurbeforethisVIruns.

statusisTRUE(X)ifanerroroccurredbeforethisVIranorFALSE(checkmark)toindicateawarningorthatnoerroroccurredbeforethisVIran.ThedefaultisFALSE.codeistheerrororwarningcode.Thedefaultis0.IfstatusisTRUE,codeisanegativeerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.Thedefaultisanemptystring.

instrumenthandleoutpassesthehandleusedtoidentifythesessioninallsubsequentNI-DCPowerVIcalls.erroroutcontainserrorinformation.IferrorinindicatesthatanerroroccurredbeforethisVIran,erroroutcontainsthesameerrorinformation.Otherwise,itdescribestheerrorstatusthatthisVIproduces.

statusisTRUE(X)ifanerroroccurredorFALSE(checkmark)toindicateawarningorthatnoerroroccurred.codetheerrororwarningcode.IfstatusisTRUE,codeisanon-zeroerrorcode.IfstatusisFALSE,codeis0ora

Page 90: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

warningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.

Page 91: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

niDCPowerSelfTestPerformsthepowersupplyself-testroutineandreturnsthetestresult(s).CallingthisVIimplicitlycallstheniDCPowerResetVI.

instrumenthandleidentifiesaparticularinstrumentsession.instrumenthandleisobtainedfromtheniDCPowerInitializeortheniDCPowerInitializeWithOptionsVI.errorin(noerror)describeserrorconditionsthatoccurbeforethisVIruns.

statusisTRUE(X)ifanerroroccurredbeforethisVIranorFALSE(checkmark)toindicateawarningorthatnoerroroccurredbeforethisVIran.ThedefaultisFALSE.codeistheerrororwarningcode.Thedefaultis0.IfstatusisTRUE,codeisanegativeerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.Thedefaultisanemptystring.

instrumenthandleoutpassesthehandleusedtoidentifythesessioninallsubsequentNI-DCPowerVIcalls.selftestresultreturnsthevalueresultfromthepowersupplyself-test.0indicatessuccess.selftestmessagereturnstheselftestresultmessage.erroroutcontainserrorinformation.IferrorinindicatesthatanerroroccurredbeforethisVIran,erroroutcontainsthesameerrorinformation.Otherwise,itdescribestheerrorstatusthatthisVIproduces.

statusisTRUE(X)ifanerroroccurredorFALSE(checkmark)toindicateawarningorthatnoerroroccurred.codetheerrororwarningcode.IfstatusisTRUE,codeisanon-zeroerrorcode.IfstatusisFALSE,codeis0orawarningcode.

Page 92: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.

Page 93: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

niDCPowerRevisionQueryReturnstherevisioninformationofNI-DCPowerandthepowersupplyfirmware.

instrumenthandleidentifiesaparticularinstrumentsession.instrumenthandleisobtainedfromtheniDCPowerInitializeortheniDCPowerInitializeWithOptionsVI.errorin(noerror)describeserrorconditionsthatoccurbeforethisVIruns.

statusisTRUE(X)ifanerroroccurredbeforethisVIranorFALSE(checkmark)toindicateawarningorthatnoerroroccurredbeforethisVIran.ThedefaultisFALSE.codeistheerrororwarningcode.Thedefaultis0.IfstatusisTRUE,codeisanegativeerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.Thedefaultisanemptystring.

instrumenthandleoutpassesthehandleusedtoidentifythesessioninallsubsequentNI-DCPowerVIcalls.firmwarerevreturnsfirmwarerevisioninformationforthepowersupply.instrdriverrevreturnsthedriverrevisioninformationforNI-DCPower.erroroutcontainserrorinformation.IferrorinindicatesthatanerroroccurredbeforethisVIran,erroroutcontainsthesameerrorinformation.Otherwise,itdescribestheerrorstatusthatthisVIproduces.

statusisTRUE(X)ifanerroroccurredorFALSE(checkmark)toindicateawarningorthatnoerroroccurred.codetheerrororwarningcode.IfstatusisTRUE,codeisanon-zeroerrorcode.IfstatusisFALSE,codeis0ora

Page 94: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

warningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.

Page 95: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

niDCPowerResetwithDefaultsResetsthepowersupplytoaknownstate.ThisVIdisablespowergeneration,resetssessionpropertiestotheirdefaultvalues,clearserrorssuchasovertemperatureandunexpectedlossofauxiliarypower,commitsthesessionproperties,andleavesthesessioninImmediatemode.InadditiontoexhibitingthebehavioroftheniDCPowerResetVI,thisVIcanassignuser-defineddefaultvaluesforconfigurablepropertiesfromtheIVIconfiguration.

instrumenthandleidentifiesaparticularinstrumentsession.instrumenthandleisobtainedfromtheniDCPowerInitializeortheniDCPowerInitializeWithOptionsVI.errorin(noerror)describeserrorconditionsthatoccurbeforethisVIruns.

statusisTRUE(X)ifanerroroccurredbeforethisVIranorFALSE(checkmark)toindicateawarningorthatnoerroroccurredbeforethisVIran.ThedefaultisFALSE.codeistheerrororwarningcode.Thedefaultis0.IfstatusisTRUE,codeisanegativeerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.Thedefaultisanemptystring.

instrumenthandleoutpassesthehandleusedtoidentifythesessioninallsubsequentNI-DCPowerVIcalls.erroroutcontainserrorinformation.IferrorinindicatesthatanerroroccurredbeforethisVIran,erroroutcontainsthesameerrorinformation.Otherwise,itdescribestheerrorstatusthatthisVIproduces.

statusisTRUE(X)ifanerroroccurredorFALSE(checkmark)toindicateawarningorthatnoerroroccurred.codetheerrororwarningcode.IfstatusisTRUE,codeisanon-zeroerrorcode.IfstatusisFALSE,codeis0ora

Page 96: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

warningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.

Page 97: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

niDCPowerGetChannelNameRetrievestheoutputchannelnamethatcorrespondstotherequestedindex.UsetheChannelCountpropertytodeterminetheupperboundofvalidvaluesforindex.

instrumenthandleidentifiesaparticularinstrumentsession.instrumenthandleisobtainedfromtheniDCPowerInitializeortheniDCPowerInitializeWithOptionsVI.indexspecifieswhichoutputchannelnametoreturn.Theindexvaluesbeginat1.errorin(noerror)describeserrorconditionsthatoccurbeforethisVIruns.

statusisTRUE(X)ifanerroroccurredbeforethisVIranorFALSE(checkmark)toindicateawarningorthatnoerroroccurredbeforethisVIran.ThedefaultisFALSE.codeistheerrororwarningcode.Thedefaultis0.IfstatusisTRUE,codeisanegativeerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.Thedefaultisanemptystring.

instrumenthandleoutpassesthehandleusedtoidentifythesessioninallsubsequentNI-DCPowerVIcalls.namereturnstheoutputchannelnamethatcorrespondstoindex.erroroutcontainserrorinformation.IferrorinindicatesthatanerroroccurredbeforethisVIran,erroroutcontainsthesameerrorinformation.Otherwise,itdescribestheerrorstatusthatthisVIproduces.

statusisTRUE(X)ifanerroroccurredorFALSE(checkmark)toindicateawarningorthatnoerroroccurred.codetheerrororwarningcode.IfstatusisTRUE,codeisanon-zeroerrorcode.IfstatusisFALSE,codeis0ora

Page 98: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

warningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.

Page 99: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

niDCPowerGetNextCoercionRecordReturnsthecoercioninformationassociatedwiththeIVIsessionandclearstheearliestinstanceinwhichNI-DCPowercoercedavalueyouspecified.

instrumenthandleidentifiesaparticularinstrumentsession.instrumenthandleisobtainedfromtheniDCPowerInitializeortheniDCPowerInitializeWithOptionsVI.errorin(noerror)describeserrorconditionsthatoccurbeforethisVIruns.

statusisTRUE(X)ifanerroroccurredbeforethisVIranorFALSE(checkmark)toindicateawarningorthatnoerroroccurredbeforethisVIran.ThedefaultisFALSE.codeistheerrororwarningcode.Thedefaultis0.IfstatusisTRUE,codeisanegativeerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.Thedefaultisanemptystring.

instrumenthandleoutpassesthehandleusedtoidentifythesessioninallsubsequentNI-DCPowerVIcalls.recordreturnsthenextcoercionrecordfortheIVIsession.Iftherearenocoercionrecords,theVIreturnsanemptystring.erroroutcontainserrorinformation.IferrorinindicatesthatanerroroccurredbeforethisVIran,erroroutcontainsthesameerrorinformation.Otherwise,itdescribestheerrorstatusthatthisVIproduces.

statusisTRUE(X)ifanerroroccurredorFALSE(checkmark)toindicateawarningorthatnoerroroccurred.codetheerrororwarningcode.IfstatusisTRUE,codeisanon-zeroerrorcode.IfstatusisFALSE,codeis0orawarningcode.

Page 100: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.

Page 101: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

niDCPowerClearInterchangeWarningsClearsthelistofcurrentinterchangewarnings.

instrumenthandleidentifiesaparticularinstrumentsession.instrumenthandleisobtainedfromtheniDCPowerInitializeortheniDCPowerInitializeWithOptionsVI.errorin(noerror)describeserrorconditionsthatoccurbeforethisVIruns.

statusisTRUE(X)ifanerroroccurredbeforethisVIranorFALSE(checkmark)toindicateawarningorthatnoerroroccurredbeforethisVIran.ThedefaultisFALSE.codeistheerrororwarningcode.Thedefaultis0.IfstatusisTRUE,codeisanegativeerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.Thedefaultisanemptystring.

instrumenthandleoutpassesthehandleusedtoidentifythesessioninallsubsequentNI-DCPowerVIcalls.erroroutcontainserrorinformation.IferrorinindicatesthatanerroroccurredbeforethisVIran,erroroutcontainsthesameerrorinformation.Otherwise,itdescribestheerrorstatusthatthisVIproduces.

statusisTRUE(X)ifanerroroccurredorFALSE(checkmark)toindicateawarningorthatnoerroroccurred.codetheerrororwarningcode.IfstatusisTRUE,codeisanon-zeroerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.

Page 102: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

niDCPowerResetInterchangeCheckConfiguresinterchangeability-checkingalgorithmstoignoreallpreviousconfigurationoptions.ThisVIdoesnotcleartheinterchangeabilitywarningsfromthelistofpreviouslyrecordedinterchangeabilitywarnings.IfyouwanttoguaranteethattheniDCPowerGetNextInterchangeWarningVIonlyreturnsthoseinterchangeabilitywarningsthataregeneratedaftercallingthisVI,clearthelistofinterchangeabilitywarningsbyrepeatedlycallingtheniDCPowerGetNextInterchangeWarningVIuntilnointerchangeabilitywarningsarereturned.Ifyouarenotinterestedinthecontentofthosewarnings,calltheniDCPowerClearInterchangeWarningsVI.Details

instrumenthandleidentifiesaparticularinstrumentsession.instrumenthandleisobtainedfromtheniDCPowerInitializeortheniDCPowerInitializeWithOptionsVI.errorin(noerror)describeserrorconditionsthatoccurbeforethisVIruns.

statusisTRUE(X)ifanerroroccurredbeforethisVIranorFALSE(checkmark)toindicateawarningorthatnoerroroccurredbeforethisVIran.ThedefaultisFALSE.codeistheerrororwarningcode.Thedefaultis0.IfstatusisTRUE,codeisanegativeerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.Thedefaultisanemptystring.

instrumenthandleoutpassesthehandleusedtoidentifythesessioninallsubsequentNI-DCPowerVIcalls.erroroutcontainserrorinformation.IferrorinindicatesthatanerroroccurredbeforethisVIran,erroroutcontainsthesameerrorinformation.Otherwise,itdescribestheerrorstatusthatthisVIproduces.

Page 103: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

statusisTRUE(X)ifanerroroccurredorFALSE(checkmark)toindicateawarningorthatnoerroroccurred.codetheerrororwarningcode.IfstatusisTRUE,codeisanon-zeroerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.

Page 104: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

DetailsWhendevelopingacomplextestsystemthatconsistsofmultipletestmodules,itisgenerallyagoodideatodesignthetestmodulessothattheycanruninanyorder.Todosorequiresensuringthateachtestmodulecompletelyconfiguresthestateofeachinstrumentituses.Ifaparticulartestmoduledoesnotcompletelyconfigurethestateofaninstrument,thestatedependsontheconfigurationfromapreviouslyexecutedtestmodule.Ifyouexecutethetestmodulesinadifferentorder,thebehavioroftheinstrumentandthereforetheentiretestmodulecanchange.Thisbehaviorchangeisgenerallyinstrument-specificandrepresentsaninterchangeabilityproblem.YoucanusetheniDCPowerResetInterchangeCheckVItotestforsuchcases.AfteryouusethisVI,theinterchangeability-checkingalgorithmsinNI-DCPowerignoreallpreviousconfigurationoperations.ByusingthisVIatthebeginningofatestmodule,youcandeterminewhetherthetestmodulehasdependenciesontheoperationofpreviouslyexecutedtestmodules.

Page 105: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

niDCPowerGetNextInterchangeWarningReturnstheinterchangeabilitywarningassociatedwiththeIVIsession.Itretrievesandclearstheearliestinstanceinwhichtheclassdriverrecordedaninterchangeabilitywarning.Interchangeabilitywarningsindicatethatusingyourapplicationwithadifferentpowersupplymaycauseadifferentbehavior.NI-DCPowerperformsinterchangeabilitycheckingwhentheInterchangeCheckpropertyissettoTRUE.ThisVIreturnsanemptystringinwarningifnointerchangeabilitywarningsremainforthesession.Ingeneral,NI-DCPowergeneratesinterchangeabilitywarningswhenapropertythataffectsthebehaviorofthepowersupplyisinastateyoudidnotspecify.

instrumenthandleidentifiesaparticularinstrumentsession.instrumenthandleisobtainedfromtheniDCPowerInitializeortheniDCPowerInitializeWithOptionsVI.errorin(noerror)describeserrorconditionsthatoccurbeforethisVIruns.

statusisTRUE(X)ifanerroroccurredbeforethisVIranorFALSE(checkmark)toindicateawarningorthatnoerroroccurredbeforethisVIran.ThedefaultisFALSE.codeistheerrororwarningcode.Thedefaultis0.IfstatusisTRUE,codeisanegativeerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.Thedefaultisanemptystring.

instrumenthandleoutpassesthehandleusedtoidentifythesessioninallsubsequentNI-DCPowerVIcalls.warningreturnsthenextinterchangewarningfortheIVIsession.Iftherearenointerchangewarnings,theVIreturnsanemptystring.erroroutcontainserrorinformation.IferrorinindicatesthatanerroroccurredbeforethisVIran,erroroutcontainsthesameerrorinformation.Otherwise,itdescribestheerrorstatusthatthisVI

Page 106: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

produces.statusisTRUE(X)ifanerroroccurredorFALSE(checkmark)toindicateawarningorthatnoerroroccurred.codetheerrororwarningcode.IfstatusisTRUE,codeisanon-zeroerrorcode.IfstatusisFALSE,codeis0orawarningcode.sourcedescribestheoriginoftheerrororwarningandis,inmostcases,thenameoftheVIthatproducedtheerrororwarning.

Page 107: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

ExamplesNI-DCPowerexamplesareinstructionaltoolsthatdemonstratepowersupplyfunctionality.Forexamplelocations,refertotheNI-DCPowerReadme.

Page 108: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

NI-DCPowerPropertiesExpandthissectiontoviewtheNI-DCPowerproperties.RefertoUsingPropertiesandAttributesformoreinformation.

Page 109: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

Channel-BasedPropertiesToaccessachannel-basedproperty,youmustwireanActiveChannelofanNI-DCPowerpropertynode.TheActiveChannelislistedfirstinthepropertynode.Toaccessadevice-basedproperty,donotwireanActiveChannelorwireanemptystring.

Page 110: NI-DCPower LabVIEW Reference Help · niDCPower Close Closes the session specified in instrument handle and deallocates the resources that NI-DCPower reserved. If power output is enabled

PropertieswithMultipleChannelsYoucanspecifymultiplechannelsbyusingachannellistorachannelrange.Achannellistisacomma(,)separatedsequenceofchannelnames(e.g.0,2specifieschannels0and2).Achannelrangeisalowerboundchannelfollowedbyahyphen(-)orcolon(:)followedbyanupperboundchannel(e.g.0-2specifieschannels0,1,and2).InImmediatemode,multipleoutputchannelconfigurationsareperformedsequentiallybasedontheorderspecifiedinActiveChannel.


Recommended