NI Modular Instruments Python API Documentation Release 1.4.3 NI Dec 16, 2022 Drivers 1 About 1 2 Installation 3 3 Contributing 5 4 Support/Feedback 7 5 Bugs/FeatureRequests 9 6 Documentation 11 6.1 AdditionalDocumentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 7 License 13 7.1 nidcpowermodule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 7.1.1 Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 7.1.2 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 7.1.3 APIReference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 7.2 nidigitalmodule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213 7.2.1 Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213 7.2.2 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213 7.2.3 APIReference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214 7.3 nidmmmodule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 319 7.3.1 Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 319 7.3.2 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 319 7.3.3 APIReference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 319 7.4 nifgenmodule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 387 7.4.1 Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 387 7.4.2 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 387 7.4.3 APIReference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 387 7.5 niscopemodule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 495 7.5.1 Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 495 7.5.2 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 495 7.5.3 APIReference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 497 7.6 niswitchmodule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 628 7.6.1 Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 628 7.6.2 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 628 i 7.6.3 APIReference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 628 7.7 nisemodule. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 677 7.7.1 Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 677 7.7.2 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 677 7.7.3 APIReference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 677 7.8 nimodinstmodule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 688 7.8.1 Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 688 7.8.2 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 688 7.8.3 APIReference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 689 7.9 nitclkmodule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 694 7.9.1 Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 694 7.9.2 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 695 7.9.3 APIReference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 695 8 Indicesandtables 709 PythonModuleIndex 711 Index 713 ii 1 CHAPTER About Thenimi-pythonrepositorygeneratesPythonbindings(ApplicationProgrammingInterface)forinteractingwiththe ModularInstrumentdrivers. Thefollowingdriversaresupported: • NI-DCPower(Pythonmodule: nidcpower) • NI-DigitalPatternDriver(Pythonmodule: nidigital) • NI-DMM(Pythonmodule: nidmm) • NI-FGEN(Pythonmodule: nifgen) • NI-ModInst(Pythonmodule: nimodinst) • NI-SCOPE(Pythonmodule: niscope) • NISwitchExecutive(Pythonmodule: nise) • NI-SWITCH(Pythonmodule: niswitch) • NI-TClk(Pythonmodule: nitclk) ItisimplementedasasetofMakotemplatesandper-drivermetafilesthatproduceaPythonmoduleforeachdriver. ThedriveriscalledthroughitspublicCAPIusingthectypesPythonlibrary. nimi-pythonsupportsalltheOperatingSystemssupportedbytheunderlyingdriver. nimi-python follows Python Software Foundation support policy for different versions. At this time this includes Python3.7andaboveusingCPython. 1 NIModularInstrumentsPythonAPIDocumentation,Release1.4.3 2 Chapter1. About 2 CHAPTER Installation DriverspecificinstallationinstructionscanbefoundonReadTheDocs: • nidcpower • nidigital • nidmm • nifgen • nimodinst • niscope • nise • niswitch • nitclk 3 NIModularInstrumentsPythonAPIDocumentation,Release1.4.3 4 Chapter2. Installation 3 CHAPTER Contributing Wewelcomecontributions! Youcanclonetheprojectrepository,buildit,andinstallitbyfollowingtheseinstructions. 5 NIModularInstrumentsPythonAPIDocumentation,Release1.4.3 6 Chapter3. Contributing